|
<< Click to display table of contents >> TCustomRichViewEdit.GetCurrentHotspotInfo |
Returns main properties for the item of hotspot type at the position of caret.
VCL and LCL:
procedure GetCurrentHotspotInfo(out AName: TRVUnicodeString;
out AImageIndex, AHotImageIndex: Integer;
out AImageList: TCustomImageList;
out ATag: TRVTag);
(changed in version 18)
FireMonkey:
procedure GetCurrentHotspotInfo(out AName: TRVUnicodeString;
out AImageIndex, AHotImageIndex: Integer;
out AImageList: TCustomImageList;
out ATag: TRVTag;
out AImageWidth, AImageHeight: TRVStyleLength);
GetCurrentHotspotInfo(...) is equivalent to TopLevelEditor.GetHotspotInfo(TopLevelEditor.CurItemNo, ...).
Output parameters:
AName – name of hotspot. It can also be read using GetCurrentItemText 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 GetCurrentItemExtraIntPropertyEx method.
AHotImageIndex – index in AImageList for "hot" image. This image is displayed under the mouse pointer (in hypertext mode), or when user moves the caret to this item (in TRichViewEdit). It can also be read using GetCurrentItemExtraIntPropertyEx method.
ATag – tag of the item. Use SetCurrentTag or SetCurrentHotspotInfo to change tag of item as an editing operation. This value can also be read using GetCurrentTag method.
Additional output 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.
This method must be called only when the document is formatted.
Additional properties of item at the position of caret are returned by the methods GetCurrentItemExtraIntProperty and GetCurrentItemExtraStrProperty.
See also methods:
▪SetCurrentHotspotInfo (changes properties of hotspot at the position of caret, as an editing operation);
▪GetHotspotInfo (returns properties of the specified hotspot).
See also properties:
See also:
▪"Tags".