rvico TRichView Reference | TRichView

TCustomRichView.GetBulletInfo

Top  Previous  Next

Returns main properties of item of bullet type

procedure GetBulletInfo(ItemNo: Integer; var AName: String;

  var AImageIndex: Integer; var AImageList: TCustomImageList;

  var ATag: Integer);

 

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.

ATag tag of the item.If tags are pointers to dynamically allocated strings (rvoTagsArePChars in Options), this procedure returns a pointer to this string (you can convert returned ATag to PChar), not to the copy of it, so you should not free it. Use SetItemTag or SetBulletInfo to change tag of item. This value can also be read using GetItemTag method.

 

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

unicode Unicode note: names of non-text items are ANSI strings.

 

See also methods:

SetBulletInfo;
GetItemStyle;
GetItemExtraIntProperty;
GetItemExtraStrProperty.

See also properties:

ItemCount.

See also:

Obtaining RichView items;
Item types.
Tags.


RichView © Sergey Tkachenko