<< Click to display table of contents >> TCustomRichViewEdit.GetCurrentBulletInfo

Returns main properties for the item of bullet type at the position of caret.

VCL and LCL:

procedure GetCurrentBulletInfo(out AName: TRVUnicodeString;

  out AImageIndex: Integer; out AImageList: TCustomImageList;

  out ATag: TRVTag);

FireMonkey:

procedure GetCurrentBulletInfo(out AName: TRVUnicodeString;

  out AImageIndex: Integer; out AImageList: TCustomImageList;

  out ATag: TRVTag;

  out AImageWidth, AImageHeight: TRVStyleLength);

GetCurrentBulletInfo(...) is equivalent to TopLevelEditor.GetBulletInfo(TopLevelEditor.CurItemNo, ...).

Output parameters:

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

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

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

ATag – tag of the item. Use SetCurrentTag or SetCurrentBulletInfo to change tag of item as an editing operation. This value can also be read using GetCurrentTag 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.

 

This method must be called only when the document is formatted.

Additional properties of item at the position of caret are returned by the methods GetCurrentItemExtraIntProperty and GetCurrentItemExtraStrProperty.

See also methods:

▪SetCurrentBulletInfo (changes properties of bullet at the position of caret, as an editing operation);

▪GetBulletInfo (returns properties of the specified bullet).

See also properties:

▪CurItemNo;

▪CurItemStyle.

See also:

▪Obtaining RichView items;

▪Item types;

▪"Tags".