<< Click to display table of contents >> TCustomRichView.SetHotspotInfo

Changes main properties of the item of hotspot (image from ImageList, hyperlink) type.

VCL and LCL:

procedure SetHotspotInfo(ItemNo: Integer;

  const AName: TRVUnicodeString;

  AImageIndex, AHotImageIndex: Integer;

  AImageList: TCustomImageList;

  const ATag: TRVTag);

(changed in version 18)

FireMonkey:

procedure SetHotspotInfo(ItemNo: Integer;

  const AName: TRVUnicodeString;

  AImageIndex, AHotImageIndex: Integer;

  AImageList: TCustomImageList;

  const ATag: TRVTag;

  AImageWidth, AImageHeight: TRVStyleLength);

Parameters:

ItemNo – index of the item. The item must be of hotspot type (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.SetHotspotInfo.

AName – name of hotspot, 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.

AImageIndex – index of "hot" image in image list. This image is displayed under the mouse pointer (in TRichView, or in TRichViewEdit in hypertext mode), or when user moves the caret to this item (in TRichViewEdit). It can also be set using SetItemExtraIntPropertyEx method.

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

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: 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.SetHotspotInfo(ItemNo, 'my image', 0, 0, nil, 'hotspot tag');

 

See also methods:

▪GetHotspotInfo;

▪GetItemStyle;

▪SetItemExtraIntProperty;

▪SetItemExtraStrProperty.

See also properties:

▪ItemCount.

See also methods of RichViewEdit:

▪SetHotspotInfoEd;

▪SetCurrentHotspotInfo.

See also:

▪Modifying RichView items;

▪Item types;

▪Tags.