<< Click to display table of contents >> TCustomRichView.GetBulletInfo

Returns main properties of item of bullet type

VCL and LCL:

procedure GetBulletInfo(ItemNo: Integer; out AName: TRVUnicodeString;

  out AImageIndex: Integer; out AImageList: TCustomImageList;

  out ATag: TRVTag);

(changed in version 18)

FireMonkey:

procedure GetBulletInfo(ItemNo: Integer; out AName: TRVUnicodeString;

  out AImageIndex: Integer; out AImageList: TCustomImageList;

  out ATag: TRVTag;

  out ImageWidth, ImageHeight: TRVStyleLength);

Input parameter:

ItemNo – index of the item. The item must be of bullet or hotspot type (rvsBullet or rvsHotspot), otherwise the method raises ERichViewError exception. Items are indexed from 0 to ItemCount-1, GetItemStyle returns type of item. Items of subdocuments (table cells) are not included in the items range of the main document; for items in cells, use Cell.GetRVData.GetBulletInfo.

 

Output parameters:

AName – name of bullet. It can also be read using GetItemText method.

AImageList – image list (a reference to image list, do not free it).

AImageIndex – index in AImageList. It can also be read using GetItemExtraIntPropertyEx method.

ATag – tag of the item. Use SetItemTag or SetBulletInfo to change tag of item. This value can also be read using GetItemTag method.

Additional output 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.

 

Additional item properties are returned by the methods GetItemExtraIntProperty and GetItemExtraStrProperty.

 

See also methods:

▪SetBulletInfo;

▪GetItemStyle;

▪GetItemExtraIntProperty;

▪GetItemExtraStrProperty.

See also properties:

▪ItemCount.

See also:

▪Obtaining RichView items;

▪Item types.

▪Tags.