TRichView Reference | TRichViewEdit

TCustomRichViewEdit.GetCurrentItemExtraStrProperty

Returns value of the specified string property of the item at the position of caret

function GetCurrentItemExtraStrProperty(

  Prop: TRVExtraItemStrProperty; var Value: String): Boolean;

(introduced in version 1.9)

GetCurrentItemExtraStrProperty(...) is equivalent to TopLevelEditor.GetItemExtraStrProperty(TopLevelEditor.CurItemNo, ...).

Value receives value of the property identified by Prop. See TRVExtraItemStrProperty for the list of available properties.

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

Return value

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

Unicode note: string properties are Unicode strings for Delphi/C++Builder 2009 or newer, and ANSI strings for older versions of Delphi/C++Builder.

See also:

▪SetCurrentItemExtraStrProperty (sets value of string property for item at the position of caret, as an editing operation);

▪SetItemExtraStrPropertyEd (sets value of string property for the specified item, as an editing operation);

▪GetCurrentItemExtraIntProperty (returns value of the specified integer property of item at the position of caret).

See also methods of TRichView:

▪GetItemExtraStrProperty.