rvico TRichView Reference | TRichView

TCustomRichView.GetBreakInfo

Top  Previous  Next

Returns main properties of item of break type

procedure GetBreakInfo(ItemNo: Integer; var AWidth: TRVStyleLength;

  var AStyle: TRVBreakStylevar AColor: TColor;

  var ATag: TRVTag);

 

Input parameter:

ItemNo – index of the item. The item must be of break type (rvsBreak), otherwise the method raises ERichViewError exception. 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.GetBreakInfo.

 

Output parameters:

AWidth – line width (or rectangle height). This value is measured in Style.Units.

AStyle – visual style of this break, see TRVBreakStyle for possible values.

AColor – line color. If it is equal to clNone, Style.TextStyles[0].Color is used.

ATag tag of the item. Use SetItemTag or SetBreakInfo to change tag of item.

 

Instead of this method, you can use GetItemExtraIntPropertyEx and GetItemTag methods.

 

Additional item properties are returned by the methods GetItemExtraIntProperty and GetItemExtraStrProperty.

 

See also methods:

SetBreakInfo;

GetItemStyle;

GetItemExtraIntProperty;

GetItemExtraStrProperty.

See also properties:

ItemCount.

See also:

Obtaining RichView items;

Item types;

Tags.


TRichView © trichview.com