a_sidenote TsrvActionInsertSidenote

Properties  | Actions overview

Top  Previous  Next

TsrvActionInsertSidenote inserts a sidenote (a note in a floating box) in the caret position.

Unit SRVActions;

Syntax

TsrvActionInsertSidenote = class(TsrvActionCustomInsertSidenote)

hmtoggle_arrow1Hierarchy

Description

If TSRichViewEdit.RichViewEdit, RVHeader or RVFooter is active, this action inserts a sidenote (TRVSidenoteItemInfo item).

If TSRichViewEdit.RVNote is active (editing a sidenote.Document), this action inserts a reference to the parent sidenote (TRVNoteReferenceItemInfo item).

Otherwise, this action is disabled.

When inserting a sidenote, this action adds in its Document the following items:

reference to this sidenote;

space character.

Attributes of inserted items depend on the target editor's UseStyleTemplates property.

If style templates are used, the sidenote and the sidenote reference characters are formatted using RefStyleTemplateName style template. Otherwise, or if this style template does not exist, they are formatted as superscript text. In the both cases, rvprDoNotAutoSwitch is included in its Protection.

If style templates are used, sidenote paragraph and text are formatted using StyleTempleteName style template. Otherwise, or if this style template does not exist, sidenote text is formatted using Font property.

The following properties are assigned to the inserted sidenote:

BoxProperties (default: width: 20% of page width, height: auto)

BoxPosition (default: horizontal - right aligned to the main text area, vertical - aligned to the top of the paragraph)

Use this action instead of TrvActionInsertSidenote.


ScaleRichView © trichview.com