TRichView Reference | TRichView

TCustomRichView.SetBreakInfo

Changes main properties of the item of break (horizontal line) type.

procedure SetBreakInfo(ItemNo: Integer; AWidth: Byte;

  AStyle: TRVBreakStyle; AColor: TColor;

  ATag: Integer);

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, use Cell.GetRVData.SetBreakInfo.

AWidth – line width (or rectangle height). Must be in range from 1 to 10.

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.If tags are pointers to dynamically allocated strings (rvoTagsArePChars in Options), this parameter must be set to value returned by StrNew of StrAlloc functions, typecasted to integer. You can use value returned by GetBreakInfo or GetItemTag for this item. The tag can also be set by SetItemTag method.

Method type: viewer-style. It's not necessary to reformat document after it, repainting is enough.

Additional item properties are assigned by the methods SetItemExtraIntProperty and SetItemExtraStrProperty.

Example

// if not (rvoTagsArePChars in RichView1.Options)

RichView1.SetBreakInfo(ItemNo, 1, rvbsLine, clNone, 1)

// if rvoTagsArePChars in RichView2.Options

RichView2.SetBreakInfo(ItemNo, 1, rvbsLine, clNone, Integer(StrNew('Break Tag')));

See also methods:

See also properties:

See also methods of RichViewEdit:

See also: