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

Modifies the item at the position of caret, if this item is a hotspot.

VCL and LCL:

procedure SetCurrentHotspotInfo(const AName: TRVUnicodeString;

  AImageIndex, AHotImageIndex: Integer; AImageList: TCustomImageList;

  const ATag: TRVTag);

FireMonkey:

procedure SetCurrentHotspotInfo(const AName: TRVUnicodeString;

  AImageIndex, AHotImageIndex: Integer; AImageList: TCustomImageList;

  const ATag: TRVTag;

  AImageWidth, AImageHeight: TRVStyleLength);

(changed in version 18)

SetCurrentHotspotInfo(...) is equivalent to TopLevelEditor.SetHotspotInfoEd(TopLevelEditor.CurItemNo, ...).

This method can be used if CurItemStyle returns rvsHotspot.

Parameters:

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

AImageList – not used, reserved, set it to nil..

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

AHotImageIndex – index of "hot" image in the 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 SetCurrentItemExtraIntPropertyEx method.

ATag – tag of the item. You can use value returned by GetCurrentHotspotInfo or GetCurrentTag for this item. The tag can also be set by SetCurrentTag 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: editing-style.

Additional item properties are assigned by the methods SetCurrentItemExtraIntProperty and SetCurrentItemExtraStrProperty.

 

See also methods:

▪GetCurrentHotspotInfo;

▪SetHotspotInfoEd.

See also properties:

▪CurItemNo;

▪CurItemStyle.

See also:

▪Modifying RichView items;

▪Item types;

▪"Tags".