TCustomRichView.SetBulletInfo

<< Click to display table of contents >>

TCustomRichView.SetBulletInfo

Changes main properties of the item of bullet (image from ImageList) type.

VCL and LCL:

procedure SetBulletInfo(ItemNo: Integer; const AName: TRVUnicodeString;

  AImageIndex: Integer; AImageList: TCustomImageList;

  const ATag: TRVTag);

(changed in version 18)

FireMonkey:

procedure SetBulletInfo(ItemNo: Integer; const AName: TRVUnicodeString;

  AImageIndex: Integer; AImageList: TCustomImageList;

  const ATag: TRVTag;

  AImageWidth, AImageHeight: TRVStyleLength);

Parameters:

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.SetBulletInfo.

AName name of bullet, any string without line break (CR, LF) characters. It can also be set using SetItemText method.

AImageList not used, reserved, set it to nil.

AImageIndex – index of image in image list. It can also be set using SetItemExtraIntPropertyEx method.

ATag tag of the item. You can use value returned by GetBulletInfo or GetItemTag for this item. The tag can also be set by SetItemTag method.

Additional parameters for FireMonkey version:

AImageWidth, AImageHeight 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. It's not necessary to reformat document after it, repainting is enough.

Additional item properties are assigned by the methods SetItemExtraIntProperty and SetItemExtraStrProperty.

 

Example

RichView1.SetBulletInfo(ItemNo, 'my image'0nil'bullet tag');

 

See also methods:

GetBulletInfo;

GetItemStyle;

SetItemExtraIntProperty;

SetItemExtraStrProperty.

See also properties:

ItemCount.

See also methods of RichViewEdit:

SetBulletInfoEd;

SetCurrentBulletInfo.

See also:

Modifying RichView items;

Item types;

Tags.