rvico TRichView Reference | Item Types

Breaks

Top  Previous  Next

Break is a horizontal line (or rectangle) of the specified width and color.

It always occupies a full line.

Style of this item type: rvsBreak (-1)

Methods of TCustomRichView

The following viewer-style methods add item of this type to the end of the document:

AddBreakExTag (also AddBreak, AddBreakEx, AddBreakTag)

The following viewer-style method changes the main properties of item of this type:

SetBreakInfo

The following method returns main properties of the given item of this type:

GetBreakInfo

Methods of TCustomRichViewEdit

The following editor-style method inserts item of this type at the position of caret:

InsertBreak

The following editor-style methods modify main properties of the item of this type:

SetCurrentBreakInfo,

SetBreakInfoEd

The following method returns main properties of the item of this type at the position of caret:

GetCurrentBreakInfo

Properties

Main properties of breaks: style, width, color.

In addition to the methods listed above, they are accessible as rveipcBreakStyle, rveipcBreakWidth, rveipcBreakColor properties.

Saving and loading

Export to HTML

Breaks are exported as <HR>. Color of break is retained only in CSS version (SaveHTMLEx, or SaveHTML with rvsoForceNonTextCSS in Options parameter)

RTF

Breaks are exported as two paragraphs, one of them with a border at the bottom side. Not imported (i.e. imported back as two paragraphs, one of them with a border at the bottom side)

Export to DocX

Breals are exported as a special line object.

Export to Text

When saving/copying selection, breaks are not included in text. When saving to file (SaveText), saved as a sequence of LineWidth  '-' characters.


TRichView © trichview.com