Class FormattingSymbolLayoutBox

Represents a layout box that contains formatting symbols within a document.

Inheritance
System.Object
LayoutElement
LayoutBox
InlineLayoutBox
SpanLayoutBox
FormattingSymbolLayoutBox
Inherited Members
Namespace: Telerik.Windows.Documents.Layout
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class FormattingSymbolLayoutBox : SpanLayoutBox, INotifyPropertyChanged

Constructors

FormattingSymbolLayoutBox(DocumentElement, DocumentStructureCollection, FormattingSymbols)

Declaration
public FormattingSymbolLayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection, FormattingSymbols symbol)
Parameters
DocumentElement associatedDocumentElement

DocumentStructureCollection collection

FormattingSymbols symbol

Fields

END_OF_CELL_SYMBOL_VISUAL

Declaration
public static readonly string END_OF_CELL_SYMBOL_VISUAL
Field Value
System.String

ENTER

Declaration
public static readonly string ENTER
Field Value
System.String

ENTER_SYMBOL_VISUAL

Declaration
public static readonly string ENTER_SYMBOL_VISUAL
Field Value
System.String

LINE_BREAK

Declaration
public static readonly string LINE_BREAK
Field Value
System.String

LINE_BREAK_VISUAL

Declaration
public static readonly string LINE_BREAK_VISUAL
Field Value
System.String

NON_BREAKING_SPACE_SYMBOL_VISUAL

Declaration
public static readonly string NON_BREAKING_SPACE_SYMBOL_VISUAL
Field Value
System.String

PAGE_BREAK

Declaration
public static readonly string PAGE_BREAK
Field Value
System.String

PAGE_BREAK_VISUAL

Declaration
public static readonly string PAGE_BREAK_VISUAL
Field Value
System.String

SPACE

Declaration
public static readonly string SPACE
Field Value
System.String

SPACE_SYMBOL_VISUAL

Declaration
public static readonly string SPACE_SYMBOL_VISUAL
Field Value
System.String

TAB

Declaration
public static readonly string TAB
Field Value
System.String

TAB_SYMBOL_VISUAL

Declaration
public static readonly string TAB_SYMBOL_VISUAL
Field Value
System.String

Properties

FormattingSymbol

Represents the layout box for a formatting symbol in the Telerik Windows Documents layout system.

Declaration
public FormattingSymbols FormattingSymbol { get; }
Property Value
FormattingSymbols

HasVisualRepresentation

Determines whether the formatting symbol has a visual representation.

Declaration
public override bool HasVisualRepresentation { get; }
Property Value
System.Boolean

Returns true if the formatting symbol is visually represented; otherwise, false.
Overrides

HasWidthAtTheEndOfLine

Determines whether the formatting symbol has a width at the end of the line.

Declaration
public override bool HasWidthAtTheEndOfLine { get; }
Property Value
System.Boolean

Overrides

IsColumnBreak

Gets a value indicating whether the current layout box represents a column break.

Declaration
public bool IsColumnBreak { get; }
Property Value
System.Boolean

IsFormattingSymbol

Gets a value indicating whether the current instance represents a formatting symbol.

Declaration
public override bool IsFormattingSymbol { get; }
Property Value
System.Boolean

Overrides

IsLastOnLine

Gets a value indicating whether this formatting symbol is the last element on the line.

Declaration
public bool IsLastOnLine { get; }
Property Value
System.Boolean

IsLineBreak

Gets a value indicating whether the layout box represents a line break.

Declaration
public bool IsLineBreak { get; }
Property Value
System.Boolean

IsPageBreak

Gets a value indicating whether the layout box is a page break.

Declaration
public bool IsPageBreak { get; }
Property Value
System.Boolean

IsParagraphEnd

Gets a value indicating whether the layout box represents the end of a paragraph.

Declaration
public bool IsParagraphEnd { get; }
Property Value
System.Boolean

IsReadonly

Gets a value indicating whether the formatting symbol layout box is read-only.

Declaration
public override bool IsReadonly { get; }
Property Value
System.Boolean

Overrides

IsSectionBreak

Gets a value indicating whether the layout box represents a section break.

Declaration
public bool IsSectionBreak { get; }
Property Value
System.Boolean

IsSpace

Gets a value indicating whether the formatting symbol represents a space character.

Declaration
public bool IsSpace { get; }
Property Value
System.Boolean

IsSplittable

Gets a value indicating whether the formatting symbol layout box can be split.

Declaration
public override bool IsSplittable { get; }
Property Value
System.Boolean

Overrides

IsTab

Gets a value indicating whether the layout box represents a tab formatting symbol.

Declaration
public bool IsTab { get; }
Property Value
System.Boolean

True if the layout box is a tab formatting symbol; otherwise, false.

PositionsCountInBox

Gets the count of positions contained within the layout box.

Declaration
public override int PositionsCountInBox { get; }
Property Value
System.Int32

Overrides

Text

Represents the text content of the FormattingSymbolLayoutBox.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

Methods

CreateEnterSibling(SpanLayoutBox)

Creates a sibling formatting symbol layout box for the specified span layout box.

Declaration
public static FormattingSymbolLayoutBox CreateEnterSibling(SpanLayoutBox siblingSpan)
Parameters
SpanLayoutBox siblingSpan

The span layout box for which to create a sibling formatting symbol layout box.
Returns
FormattingSymbolLayoutBox

A new instance of FormattingSymbolLayoutBox that serves as a sibling to the provided span layout box.

CreateFormattingSymbolSibling(SpanLayoutBox, FormattingSymbols)

Creates a sibling formatting symbol layout box for the specified span layout box.

Declaration
public static FormattingSymbolLayoutBox CreateFormattingSymbolSibling(SpanLayoutBox siblingSpan, FormattingSymbols symbol)
Parameters
SpanLayoutBox siblingSpan

The span layout box to which the formatting symbol will be associated.
FormattingSymbols symbol

The formatting symbol to create a sibling layout box for.
Returns
FormattingSymbolLayoutBox

A new instance of the FormattingSymbolLayoutBox that acts as a sibling to the specified span layout box.

CreateSpaceSibling(SpanLayoutBox)

Creates a space sibling for the specified SpanLayoutBox instance.

Declaration
public static FormattingSymbolLayoutBox CreateSpaceSibling(SpanLayoutBox siblingSpan)
Parameters
SpanLayoutBox siblingSpan

The SpanLayoutBox for which the space sibling is to be created.
Returns
FormattingSymbolLayoutBox

Returns a new instance of FormattingSymbolLayoutBox representing the space sibling.

CreateTabSibling(SpanLayoutBox)

Creates a tab sibling for the specified SpanLayoutBox.

Declaration
public static FormattingSymbolLayoutBox CreateTabSibling(SpanLayoutBox siblingSpan)
Parameters
SpanLayoutBox siblingSpan

The SpanLayoutBox to create a tab sibling for.
Returns
FormattingSymbolLayoutBox

A new instance of FormattingSymbolLayoutBox that represents the tab sibling.

GetFormattingHashCode(Span)

Gets the formatting hash code for the specified span.

Declaration
public int GetFormattingHashCode(Span span)
Parameters
Span span

The span for which to calculate the formatting hash code.
Returns
System.Int32

Returns an integer representing the formatting hash code of the specified span.

MeasureTextOverride(SubStringPosition)

Declaration
protected override BoxMeasurementInfo MeasureTextOverride(SubStringPosition subStringPosition)
Parameters
Telerik.Windows.Documents.Core.TextMeasurer.SubStringPosition subStringPosition

Returns
BoxMeasurementInfo

Overrides

Extension Methods