rvico TRichView Reference | TRichViewEdit

TCustomRichViewEdit.SetBreakInfoEd

Top  Previous  Next

An editing-style method for changing properties of the ItemNo-th item of RichView, if this item is a break.

procedure SetBreakInfoEd(ItemNo: Integer; AWidth: TRVStyleLength;

  AStyle: TRVBreakStyle; AColor: TColor; const ATag: TRVTag);

Parameters:

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, activate inplace-editor, select the proper item in the cell (SelSelectionBounds), and call SetBreakInfoEd of this inplace-editor. Alternatively, you can use SetCurrentBreakInfo.

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. You can use value returned by GetBreakInfo or GetItemTag for this item.

 

Instead of this method, you can use SetItemExtraIntPropertyExEd and SetItemTagEd methods.

 

Method type: editstyle editing-style (unlike SetBreakInfo).

Additional item properties are assigned by the methods SetItemExtraIntPropertyEd and SetItemExtraStrPropertyEd.

When possible, use SetCurrentBreakInfo instead of this method.

 

See also methods of TCustomRichView:

GetBreakInfo;
GetItemStyle;
SetBreakInfo.

See also methods:

SetCurrentBreakInfo.

See also properties:

ItemCount.

See also:

Modifying RichView items;
Item types;
"Tags".


TRichView © trichview.com