NoteRangeStartBase
Base for footnote and endnote reference markers that calculate their displayed labels from custom marks or numbering settings.
Definition
Namespace:Telerik.WinForms.Documents.Model.Notes
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public abstract class NoteRangeStartBase : MarkRangeStartBase, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor
Inheritance: objectDisposableObjectRadObjectDocumentElementInlineAnnotationMarkerBaseAnnotationRangeMarkerBaseAnnotationRangeStartFieldRangeStartBaseMarkRangeStartBaseNoteRangeStartBase...
Derived Classes:
Implements:
Inherited Members
Constructors
protected NoteRangeStartBase()
Properties
Gets a value indicating whether the associated note supplies custom reference text instead of an automatic number.
public bool HasCustomMark { get; }
Gets the note paired with this range start, or null when the range has no end marker.
public Note Note { get; }
Gets the style name applied to the note's reference marker in its body.
public abstract string NoteStyleName { get; }
Methods
Leaves content copying empty because the note body and custom mark are stored on the paired range end.
protected override void CopyContentFromOverride(DocumentElement fromElement)
Overrides:
Gets the reference markers of the same note type from the specified document.
protected abstract IEnumerable<NoteRangeStartBase> GetNotesCollection(RadDocument doc)
The document containing the note markers.
Returns:IEnumerable<NoteRangeStartBase>
The note markers used to calculate this reference's position in its numbering sequence.
Gets the numbering settings that apply to a note in the specified section.
protected abstract void GetNoteSettings(Section section, out NumberingRestartType restartType, out ListNumberingFormat numberingFormat, out int notesFirstNumber)
The section containing the note.
restartTypeNumberingRestartTypeReceives whether numbering continues across pages and sections or restarts at each page or section.
numberingFormatListNumberingFormatReceives the format used to render the reference marker.
notesFirstNumberintReceives the base number added to the calculated reference ordinal.
Recalculates this reference's displayed text and synchronizes the corresponding marker in the note body.
public override void UpdateAssociatedSpan()
Overrides:
Replaces the text in each reference marker inside the note body and notifies the body if any marker changed.
public void UpdateBodyDocumentMarks(string markText)
The reference text to apply to the note body's markers.