TCustomRichView.AddBullet

<< Click to display table of contents >>

TCustomRichView.AddBullet

Adds a bullet (an image from TImageList) to the end of document.

VCL and LCL:

procedure AddBullet(const AName: TRVUnicodeString;

  ImageIndex: Integer; ImageList: TCustomImageList; 

  ParaNo: Integer = -1; VAlign: TRVVAlign = rvvaBaseline;

  const Tag: TRVTag = RVEMPTYTAG);

(changed in version 18)

FireMonkey:

procedure AddBullet(const AName: TRVUnicodeString;

  ImageIndex: Integer; ImageList: TCustomImageList;

  ParaNo: Integer = -1; VAlign: TRVVAlign = rvvaBaseline;

  const Tag: TRVTag = RVEMPTYTAG;

  ImageWidth: TRVStyleLength = 16;

  ImageHeight: TRVStyleLength = 16);

Alternatives:

If you want to add a hyperlink-picture from image list, add a hotspot instead.

If you want to add a normal picture, add a picture instead.

If you want to add a normal picture-hyperlink, add a hot picture instead.

Parameters:

AName name of bullet, any string. AName must not contain CR and LF characters. TRichView does not use item names itself, they are for your own use.

ImageIndex index of image in ImageList.

ImageList image list for this bullet. TRichView does not own, does not copy and does not destroy image lists, it just holds pointers to them. So this image list is not destroyed when the document is cleared.

If ParaNo=-1, the method adds an item to the end of the last paragraph. If ParaNo>=0, this item starts a new paragraph using attributes defined in Style.ParaStyles[ParaNo].

Tag tag of this bullet.

Additional parameters for FireMonkey version:

ImageWidth, ImageHeight the desired size of the image. The component chooses the image that fits the specified size. The image is not scaled.

Method type: viewerstyle viewer-style.

See also methods:

Format;

FormatTail;

SetAddParagraphMode.

See also methods of TRichViewEdit:

InsertBullet.

See also properties of TRVStyle:

ParaStyles.

See also:

Item types;

Other methods for appending items;

"Tags".


Related deprecated methods:

procedure AddBulletExTag(const Name: TRVUnicodeString

  ImageIndex: Integer; ImageList: TCustomImageList;

  ParaNo: Integer; const Tag: TRVTag);

procedure AddBulletEx(const Name: TRVUnicodeString;

  ImageIndex: Integer; ImageList: TCustomImageList;

  ParaNo: Integer);

These methods provide subset of functionality of AddBullet.