TCustomRichViewEdit.SetHotspotInfoEd

<< Click to display table of contents >>

TCustomRichViewEdit.SetHotspotInfoEd

An editing-style method for changing properties of the ItemNo-th item of RichView, if this item is a hotspot.

VCL and LCL:

procedure SetHotspotInfoEd(ItemNo: Integer;

  const AName: TRVUnicodeString;

  AImageIndex,  AHotImageIndex: Integer;

  AImageList: TCustomImageList; const ATag: TRVTag);

(changed in version 18)

FireMonkey:

procedure SetHotspotInfoEd(ItemNo: Integer;

  const AName: TRVUnicodeString;

  AImageIndex,  AHotImageIndex: Integer;

  AImageList: TCustomImageList; const ATag: TRVTag;

  ImageWidth, ImageHeight: 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, activate inplace-editor, select the proper item in the cell  (SelSelectionBounds), and call SetHotspotInfoEd of this inplace-editor. Alternatively, you can use SetCurrentHotspotInfo.

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

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

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

AHotImageIndex – 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 SetItemExtraIntPropertyExEd 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 SetItemTagEd method.

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 (unlike SetHotspotInfo).

Additional item properties are assigned by the methods SetItemExtraIntPropertyEd and SetItemExtraStrPropertyEd.

When possible, use SetCurrentHotspotInfo instead of this method.

 

See also methods of TCustomRichView:

▪GetHotspotInfo;

▪GetItemStyle;

▪SetHotspotInfo.

See also methods:

▪SetCurrentHotspotInfo.

See also properties:

▪ItemCount.

See also:

▪Modifying RichView items;

▪Item types;

▪"Tags".