rvico TRichView Reference | TRichView

TCustomRichView.GetHotspotInfo

Top  Previous  Next

Returns main properties for item of hotspot type

procedure GetHotspotInfo(ItemNo: Integer; var AName: TRVAnsiString;

  var AImageIndex, AHotImageIndex: Integer;

  var AImageList: TCustomImageList;

  var ATag: TRVTag);

 

Input parameter:

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

 

Output parameters:

AName – name of hotspot. It can also be read using GetItemText method.

AImageList – image list (a reference to image list, do not free it).

AImageIndex – index in AImageList for normal image.It can also be read using GetItemExtraIntPropertyEx method.

AHotImageIndex – index in AImageList for "hot" image. 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 read using GetItemExtraIntPropertyEx method.

ATag tag of the item. Use SetItemTag or SetHotspotInfo to change tag of item. This value can also be read using GetItemTag method.

 

Additional item properties are returned by the methods GetItemExtraIntProperty and GetItemExtraStrProperty.

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

 

See also methods:

SetHotspotInfo;

GetItemStyle;

GetItemExtraIntProperty;

GetItemExtraStrProperty.

See also properties:

ItemCount.

See also:

Obtaining RichView items;

Item types;

Tags.


TRichView © trichview.com