rvico TRichView Reference | Item Types

Footnotes

Top  Previous  Next

A footnote looks like a number (numbering type is specified in TRVStyle.FootnoteNumbering). If FormatString is defined, a number is displayed formatted according to this string (for example, if FormatString is a single character, the footnote displays a single character).

Footnote contains a subdocument. This subdocument is not displayed in TCustomRichView where the footnote is inserted, but it can be printed. Subdocuments for all footnotes are printed at the bottom of page where this footnote occurs. TRichView cannot print text for a footnote on several pages.

srv_icon ScaleRichView note: TSRichViewEdit displays and allows editing footnotes.

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

Style of this item type: rvsFootnote (-203)

Methods of TCustomRichView

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

AddItem (create TRVFootnoteItemInfo object, add it using AddItem)

The following method returns TRVFootnoteItemInfo object

GetItem

Methods of TCustomRichViewEdit

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

InsertItem (create TRVFootnoteItemInfo object, insert it using InsertItem)

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

GetCurrentItem.

The following methods change properties of items as editing operations:

SetCurrentItemExtraIntPropertyEx;

SetItemExtraIntPropertyExEd;

SetCurrentItemExtraStrPropertyEx;

SetItemExtraStrPropertyExEd.

Properties

Footnotes have all properties of numbered sequences.

Differences:

NumberType is read-only; it always returns TRVStyle.FootnoteNumbering;

SeqName = '@footnote@' and must not be changed.

Saving and Loading

Export to HTML

Subdocuments for all footnotes are saved after the main document. Before each subdocument, <a name="footnoteN"></a> is inserted, where N is an index of this footnote (in the list of all numbered sequences and notes). Footnotes are saved as hyperlinks to this anchor.

RTF

Footnotes can be exported in RTF. If FormatString contains a single character, it can be exported to RTF.

You can set RTFReadProperties.IgnoreNotes to True, and footnotes will not be imported from RTF.

DocX

Footnotes can be exported in DocX. If FormatString contains a single character, it can be exported to DocX.

Text

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

This is a text [1 sequence of characters] to show footnotes [2 note of text placed at the bottom of a page].


TRichView © trichview.com