Represents a non-editable formatting marker and its text or visual glyph in the layout tree.
Definition
Namespace:Telerik.WinForms.Documents.Layout
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class FormattingSymbolLayoutBox : SpanLayoutBox, IDisposable, ICustomTypeDescriptor, INotifyPropertyChanged
Inheritance: objectDisposableObjectRadObjectLayoutElementLayoutBoxInlineLayoutBoxSpanLayoutBoxFormattingSymbolLayoutBox...
Implements:
Inherited Members
Constructors
Initializes a formatting-symbol box for the specified document element and symbol kind.
public FormattingSymbolLayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection, FormattingSymbols symbol)
The document element associated with the symbol.
collectionDocumentStructureCollectionThe document structure collection that owns the box.
symbolFormattingSymbolsThe formatting-symbol kind represented by the box.
Fields
Gets the currency-sign glyph used to display an end-of-cell marker.
public static readonly string END_OF_CELL_SYMBOL_VISUAL
Gets the platform newline string used for a paragraph-ending marker.
public static readonly string ENTER
Gets the pilcrow glyph used to display a paragraph-ending marker.
public static readonly string ENTER_SYMBOL_VISUAL
Gets the not-sign character used as the layout token for a line break.
public static readonly string LINE_BREAK
Gets the not-sign glyph used to display a line break.
public static readonly string LINE_BREAK_VISUAL
Gets the degree-sign glyph used to display a non-breaking space.
public static readonly string NON_BREAKING_SPACE_SYMBOL_VISUAL
Gets the lozenge character used as the layout token for a page break.
public static readonly string PAGE_BREAK
Gets the lozenge glyph used to display a page break.
public static readonly string PAGE_BREAK_VISUAL
Gets the regular space character used as the layout token for a space.
public static readonly string SPACE
Gets the text representation returned for a regular space formatting symbol.
public static readonly string SPACE_SYMBOL_VISUAL
Gets the horizontal tab character used as the layout token for a tab.
public static readonly string TAB
Gets the right-arrow glyph used to display a tab.
public static readonly string TAB_SYMBOL_VISUAL
Properties
Gets the formatting-symbol kind represented by this box.
public FormattingSymbols FormattingSymbol { get; }
Gets whether the symbol has a visual representation; the current implementation always returns true.
public override bool HasVisualRepresentation { get; }
Overrides:
Gets whether a tab or non-breaking space contributes width at the end of a line.
public override bool HasWidthAtTheEndOfLine { get; }
Overrides:
Gets whether this box represents a column break.
public bool IsColumnBreak { get; }
Gets whether this box represents a formatting symbol rather than editable span text.
public override bool IsFormattingSymbol { get; }
Overrides:
Gets whether this is an end-of-line marker: a paragraph end, page break, line break, or column break.
public bool IsLastOnLine { get; }
Gets whether this box represents a line break or vertical tab.
public bool IsLineBreak { get; }
Gets whether this box represents a page break.
public bool IsPageBreak { get; }
Gets whether this box represents a paragraph-ending Enter marker.
public bool IsParagraphEnd { get; }
Gets whether this symbol's text is read-only.
public override bool IsReadonly { get; }
Overrides:
Gets whether this paragraph-ending marker closes the final layout fragment of a section followed by another section.
public bool IsSectionBreak { get; }
Gets whether this box represents a regular or non-breaking space.
public bool IsSpace { get; }
Gets whether this symbol can be split into multiple layout fragments; formatting symbols cannot be split.
public override bool IsSplittable { get; }
Overrides:
Gets the single document position represented by this formatting symbol.
public override int PositionsCountInBox { get; }
Overrides:
Gets the glyph used to display this symbol. Setting the text is not supported.
public override string Text { get; set; }
The text of a formatting symbol cannot be set.
Overrides:
Methods
Creates an unattached paragraph-ending formatting-symbol box associated with the supplied span box.
public static FormattingSymbolLayoutBox CreateEnterSibling(SpanLayoutBox siblingSpan)
The span box whose document association and collection are reused.
Returns:A new box; it is not inserted into the layout tree.
Creates an unattached formatting-symbol box associated with the same document element and collection as the supplied span box.
public static FormattingSymbolLayoutBox CreateFormattingSymbolSibling(SpanLayoutBox siblingSpan, FormattingSymbols symbol)
The span box whose document association and collection are reused.
symbolFormattingSymbolsThe formatting-symbol kind to represent.
Returns:A new box; it is not inserted into the layout tree.
Creates an unattached regular-space formatting-symbol box associated with the supplied span box.
public static FormattingSymbolLayoutBox CreateSpaceSibling(SpanLayoutBox siblingSpan)
The span box whose document association and collection are reused.
Returns:A new box; it is not inserted into the layout tree.
Creates an unattached tab formatting-symbol box associated with the supplied span box.
public static FormattingSymbolLayoutBox CreateTabSibling(SpanLayoutBox siblingSpan)
The span box whose document association and collection are reused.
Returns:A new box; it is not inserted into the layout tree.
Creates the cache key for marker measurements from the rendered text and the span's font and baseline properties.
Measures the marker glyph with the span's formatting and reuses cached size data for matching formatting. Paragraph-ending markers use the paragraph-symbol style; an explicit width overrides the measured width.
protected override BoxMeasurementInfo MeasureTextOverride(SubStringPosition subStringPosition = SubStringPosition.None)
Ignored because a formatting marker is measured as a complete glyph.
Returns:The measured size and baseline information for the marker.
Overrides: