TCustomRichViewEdit.InsertHotspot

<< Click to display table of contents >>

TCustomRichViewEdit.InsertHotspot

Inserts hotspot at the position of caret.

VCL and LCL:

function InsertHotspot(ImageIndex, HotImageIndex: Integer;

  ImageList: TCustomImageList): Boolean;

FireMonkey:

function InsertHotspot(ImageIndex, HotImageIndex: Integer;

  ImageList: TCustomImageList;
  ImageWidth, ImageHeight: TRVStyleLength): Boolean;

Parameters:

Name name of hotspot, any string. Name must not contain CR and LF characters. RichViewEdit does not use item names itself, they are for your own use.

ImageIndex index of image in ImageList.

HotImageIndex index of "hot" image in ImageList. It is displayed when the mouse pointer is above this hotspot.

ImageList image list for this bullet. RichView does not own, does not copy and does not destroy image lists, it just holds pointers to them. So this image list is not destroyed when the document is cleared.

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 method for insertion.

Return value:

True if the insertion was successful (it can fail due to protection, or when inserting in table having multicell selection)

 

See also methods of TCustomRichView:

AddHotspot.

See also:

Inserting items at position of caret;

Hypertext in RichView;

Item types.