TCustomRichViewEdit.GetCurrentItemExtraIntProperty, GetCurrentItemExtraIntPropertyEx

<< Click to display table of contents >>

TCustomRichViewEdit.GetCurrentItemExtraIntProperty, GetCurrentItemExtraIntPropertyEx

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

function GetCurrentItemExtraIntProperty(

  Prop: TRVExtraItemPropertyout Value: Integer): Boolean;

function GetCurrentItemExtraIntPropertyEx(

  Prop: Integerout Value: Integer): Boolean;

(introduced in versions 1.7 and 15)

GetCurrentItemExtraIntProperty[Ex](...) is equivalent to TopLevelEditor.GetItemExtraIntProperty[Ex](TopLevelEditor.CurItemNo, ...).

Value receives value of the property identified by Prop.

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

In GetCurrentItemExtraIntPropertyEx, Prop's type is Integer. If Prop can be converted to TRVExtraItemProperty, GetCurrentItemExtraIntPropertyEx works like GetCurrentItemExtraIntProperty. In addition, it supports properties identified by rveipc*** constants

These methods must be called only when the document is formatted.

Return value

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

See also

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

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

GetCurrentItemExtraStrProperty (return a value of the specified string property of the item at the position of caret).

See also methods of TRichView