TCustomRichViewEdit.SetBulletInfoEd

<< Click to display table of contents >>

TCustomRichViewEdit.SetBulletInfoEd

An editing-style method for changing properties of the ItemNo-th item of TRichView, if this item is a bullet or hotspot.

VCL and LCL:

procedure SetBulletInfoEd(ItemNo: Integer;

  const AName: TRVUnicodeString; AImageIndex: Integer; 

  AImageList: TCustomImageList; const ATag: TRVTag);

FireMonkey:

procedure SetBulletInfoEd(ItemNo: Integer;

  const AName: TRVUnicodeString; AImageIndex: Integer; 

  AImageList: TCustomImageList; const ATag: TRVTag;

  ImageWidth, ImageHeight: TRVStyleLength);

(changed in version 18)

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, activate inplace-editor, select the proper item in the cell (SelSelectionBounds), and call SetBulletInfoEd of this inplace-editor. Alternatively, you can use SetCurrentBulletInfo.

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

AImageList not used, reserved, set it to nil.

AImageIndex – index of image in image list. It can also be set using SetItemExtraIntPropertyExEd 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 SetItemTagEd method.

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: editstyle editing-style (unlike SetBulletInfo).

Additional item properties are assigned by the methods SetItemExtraIntPropertyEd and SetItemExtraStrPropertyEd.

When possible, use SetCurrentBulletInfo instead of this method.

 

See also methods of TCustomRichView:

GetBulletInfo;

GetItemStyle;

SetBulletInfo.

See also methods:

SetCurrentBulletInfo.

See also properties:

ItemCount.

See also:

Modifying RichView items;

Item types;

"Tags".