rvico TRichView Reference | Item Types

Text Box Item

Top  Previous  Next

A text box item is a simplified version of a sidenote. There is no visible text at the place of insertion of this item.

If rvoShowSpecialCharacters is included in RichView.Options, a special marks are displayed in places of insertion of text box items.

Sidenote contains a subdocument. This subdocument is not displayed in TCustomRichView where the text box item is inserted, but it can be printed inside a floating box.

srv_icon ScaleRichView note: TSRichViewEdit displays and allows editing text boxes.

Class for this item type is TRVTextBoxItemInfo  (see for detailed information).

Style of this item type: rvsTextBox (-207)

Methods of TCustomRichView

The following viewer-style method adds item of this type to the end of the document:

AddItem (create TRVSidenoteItemInfo object, add it using AddItem)

The following method returns TRVSidenoteItemInfo object

GetItem

Methods of TCustomRichViewEdit

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

InsertItem (create TRVSidenoteItemInfo object, insert it using InsertItem)

The following method returns TRVSidenoteItemInfo object at the position of caret:

GetCurrentItem.

The following methods change properties of items as editing operations:

SetCurrentItemExtraIntPropertyEx;

SetItemExtraIntPropertyExEd;

SetCurrentItemExtraStrPropertyEx;

SetItemExtraStrPropertyExEd.

Properties

Text box items have all properties of sidenotes, but almost all of them are ignored.

Only floating box-related properties are used: BoxPosition and BoxProperties.

Saving and Loading

Export to HTML

Text boxes are not exported to HTML.

RTF and DocX

Text boxes are exported to RTF and DocX.

See the comments about export of sidenotes for compatibility with Microsoft Word.

Text

When copying or saving a selected text, text boxes are not included in text. When saving the whole text, they are saved inside [], for example:

This is a text[sequence of characters] to show text boxes[text placed in a floating box].


TRichView © trichview.com