TCustomRichView.GetTextInfo

<< Click to display table of contents >>

TCustomRichView.GetTextInfo

Returns text and tag for the ItemNo-th item

procedure GetTextInfo(ItemNo: Integer; out AText: TRVUnicodeString;

  out ATag: TRVTag);

(changed in version 18)

Input parameter:

ItemNo index of the item. The item must be of text type (GetItemStyle must return zero or positive value for this item), otherwise the method raises ERichViewError exception. Items are indexed from 0 to ItemCount-1. Items of subdocuments (table cells) are not included in the items range of the main document; for items in cells, use Cell.GetRVData.GetTextInfo.

Output parameters:

AText item text (visible text). This is the same value as returned by GetItemText.

ATag tag of the item. Use SetItemTag to change tag of item. The tag can also be returned by GetItemTag.

 

See also methods:

GetItemStyle;

GetItemText, SetItemText;

GetItemTag, SetItemTag.

See also properties:

ItemCount.

See also:

Obtaining items;

Item types;

"Tags".