rvico TRichView Reference | TRichView

TCustomRichView.GetItemExtraStrProperty, GetItemExtraStrPropertyEx

Top  Previous  Next

The methods return a value of the specified string property for the ItemNo-th item

function GetItemExtraStrProperty(ItemNo: Integer;

  Prop: TRVExtraItemStrPropertyvar Value: String): Boolean;

function GetItemExtraStrPropertyEx(ItemNo, Prop: Integer;

  var Value: String): Boolean;

(introduced in versions 1.9 and 15)

ItemNo – index of the item. Items are indexed from 0 to ItemCount-1, GetItemStyle returns type of item. Items of subdocuments (table cells) are not included in the items range of the main document; for items in cells, use Cell.GetRVData.GetItemExtraStrProperty[Ex].

Value receives value of the property identified by Prop.

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

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

 

Return value:

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

 

unicode 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:

SetItemExtraStrProperty[Ex];

GetItemExtraIntProperty[Ex].

See also methods of TRichViewEdit:

GetCurrentItemExtraStrProperty[Ex].


TRichView © trichview.com