TCustomRichViewEdit.GetCurrentItemExtraStrProperty, GetCurrentItemExtraStrPropertyEx

<< Click to display table of contents >>

TCustomRichViewEdit.GetCurrentItemExtraStrProperty, GetCurrentItemExtraStrPropertyEx

The methods return a value of the specified string property of the item at the position of caret

function GetCurrentItemExtraStrProperty(

  Prop: TRVExtraItemStrPropertyout Value: TRVUnicodeString): Boolean;

function GetCurrentItemExtraStrProperty(

  Prop: Integer; out Value: TRVUnicodeString): Boolean;

(introduced in versions 1.9 and 15; changed in version 18)

GetCurrentItemExtraStrProperty[Ex](...) is equivalent to TopLevelEditor.GetItemExtraStrProperty[Ex](TopLevelEditor.CurItemNo, ...).

Value receives value of the property identified by Prop.

In GetCurrentItemExtraStrProperty, Prop's type is TRVExtraItemStrProperty. See information about this type for the list of properties.

In GetCurrentItemExtraStrPropertyEx, Prop's type is Integer. If Prop can be converted to TRVExtraItemStrProperty, GetCurrentItemExtraStrPropertyEx works like GetCurrentItemExtraStrProperty. In addition, it supports properties identified by rvespc*** constants

This method must be called only when the document is formatted.

Return value

True, if this item has this property. False, if not.


See also:

SetCurrentItemExtraStrProperty[Ex] (set a value of a string property for the item at the position of caret, as an editing operation);

SetItemExtraStrProperty[Ex]Ed (set a value of a string property for the specified item, as an editing operation);

GetCurrentItemExtraIntProperty[Ex] (return a value of the specified integer property of the item at the position of caret).

See also methods of TRichView: