<< Нажмите, чтобы показать Содержание >> TCustomRichView.GetHotspotInfo

Возвращает основные свойства элемента документа: интерактивного значка.

VCL и LCL:

procedure GetHotspotInfo(ItemNo: Integer; out AName: TRVUnicodeString;

  out AImageIndex, AHotImageIndex: Integer;

  out AImageList: TCustomImageList;

  out ATag: TRVTag);

FireMonkey:

procedure GetHotspotInfo(ItemNo: Integer; out AName: TRVUnicodeString;

  out AImageIndex, AHotImageIndex: Integer;

  out AImageList: TCustomImageList;

  out ATag: TRVTag;

  out ImageWidth, ImageHeight: TRVStyleLength);

Входной параметр:

ItemNo – номер элемента. Элемент должен быть интерактивным значком (rvsHotspot), в противном случае метод вызывает исключение ERichViewError. Элементы документа нумеруются от 0 до ItemCount-1, GetItemStyle возвращает тип элемента. Элементы поддокументов (ячеек таблиц) не включены в диапазон элементов основного документа; для элементов в ячейках используйте Cell.GetRVData.GetHotspotInfo.

 

Выходные параметры:

AName – имя элемента. Оно также может быть получено методом GetItemText.

AImageList – компонент-список изображений (ссылка на него; не освобождайте память под значение, возвращённое в этом параметре).

AImageIndex – номер изображения в AImageList. Он также может быть получен методом GetItemExtraIntPropertyEx.

AHotImageIndex – номер изображения в AImageList, показываемого под указателем мыши (в TRichView, или в TRichViewEdit в режиме гипертекста), или когда каретка перемещается к этому элементу (в TRichViewEdit). Он также может быть получен методом GetItemExtraIntPropertyEx.

ATag – тег элемента. Используйте SetItemTag или SetHotspotInfo для его изменения. Он также может быть получен методом GetItemTag.

Дополнительные выходные параметры для версии FireMonkey:

ImageWidth, ImageHeight – желательный размер изображения. Выбирается самый подходящий по размеру вариант изображения. Он не масштабируется.

 

Дополнительные свойства элемента возвращаются методами GetItemExtraIntProperty и GetItemExtraStrProperty.

 

См. также методы:

▪SetHotspotInfo;

▪GetItemStyle;

▪GetItemExtraIntProperty;

▪GetItemExtraStrProperty.

См. также свойства:

▪ItemCount.

См. также:

▪Получение элементов документа;

▪Типы элементов документа;

▪Теги.