rvico TRichView Reference | TRichViewEdit

TCustomRichViewEdit.SetCurrentHotspotInfo

Top  Previous  Next

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

procedure SetCurrentHotspotInfo(const AName: TRVAnsiString;

  AImageIndex, AHotImageIndex: Integer; AImageList: TCustomImageList;

  const ATag: TRVTag);

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

 

Method type: editstyle editing-style.

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

unicode Unicode note: names of non-text items are ANSI strings.

 

See also methods:

GetCurrentHotspotInfo;

SetHotspotInfoEd.

See also properties:

CurItemNo;

CurItemStyle.

See also:

Modifying RichView items;

Item types;

"Tags".


TRichView © trichview.com