sidenote TrvActionInsertSidenote

Properties

Top  Previous  Next

TrvActionInsertSidenote inserts a new sidenote (a note in a floating box) in the document.

Unit RichViewActions;

Syntax

TrvActionCustomInsertSidenote = class(TrvActionCustomInsertSidenote)

hmtoggle_arrow1Hierarchy

Description

srv_icon ScaleRichView note: it's not recommended to use this action for TSRichViewEdit. Use TsrvActionInsertSidenote instead.

TrvActionInsertSidenote inserts a new sidenote in the document, then executes ActionEditNote to open an editor for this note.

If TrvActionEditNote's editor is active when this action is executed, this action inserts a reference to the parent sidenote (TRVNoteReferenceItemInfo item).

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 StyleTemplateName 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)


RichViewActions © trichview.com