Back to all docs
API Reference / Telerik.Windows.Documents.Layout / FormattingSymbolLayoutBox

Class
FormattingSymbolLayoutBox

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

Definition

Namespace:Telerik.Windows.Documents.Layout

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:
cs-api-definition
public class FormattingSymbolLayoutBox : SpanLayoutBox, INotifyPropertyChanged

Inheritance: objectLayoutElementLayoutBoxInlineLayoutBoxSpanLayoutBoxFormattingSymbolLayoutBox

Implements: INotifyPropertyChanged

Inherited Members SpanLayoutBox.CreateLayoutElement()SpanLayoutBox.OnPropertyChanged(string)SpanLayoutBox.ToString()SpanLayoutBox.OnAssociateDocumentElementChanged()SpanLayoutBox.CreateSpanLayoutBox(DocumentElement, DocumentStructureCollection, string)SpanLayoutBox.IsWordStart()SpanLayoutBox.MeasureOverride(SizeF)SpanLayoutBox.MergeWithNext(LayoutBox)SpanLayoutBox.ContainsFormattingSymbol(string)SpanLayoutBox.CreateNewFragment(float, bool)SpanLayoutBox.SplitSpanByIndex(int, bool)SpanLayoutBox.Update(string)SpanLayoutBox.InvalidateTextMeasure()SpanLayoutBox.GetPositionHandler()SpanLayoutBox.IsDecimalSpanLayoutBox.IsContainerBoxSpanLayoutBox.CanCreateLayoutBoxesFromContentSpanLayoutBox.DesiredTextSizeSpanLayoutBox.AssociatedSpanSpanLayoutBox.IsParagraphSymbolSpanLayoutBox.BaselineOffsetSpanLayoutBox.PropertyChangedInlineLayoutBox.Remove()InlineLayoutBox.LineInfoInlineLayoutBox.LineSegmentInfoInlineLayoutBox.IsRtlInlineLayoutBox.AssociatedInlineInlineLayoutBox.IsStartOfLineSegmentLayoutBox.currentYLayoutBox.AssociatedLayoutBoxPropertyLayoutBox.NodeLayoutBox.GetAssociatedLayoutBox(UIElement)LayoutBox.SetAssociatedLayoutBox(UIElement, LayoutBox)LayoutBox.OnElementStructureChanging()LayoutBox.OnElementStructureChanged()LayoutBox.CreateChildrenCollection(DocumentStructureCollection)LayoutBox.InvalidateMeasureUpToTheRoot()LayoutBox.InvalidateMeasureUpToTheRootStable()LayoutBox.InvalidateArrangeUpToTheRoot()LayoutBox.InvalidateLayoutAfterEdit()LayoutBox.ValidateChild(LayoutBox)LayoutBox.GetRootDocument()LayoutBox.CanGrowVerticallyOverride(float)LayoutBox.CanGrowVertically(float)LayoutBox.GetBoxDesiredGrow()LayoutBox.CreateNewFragment(LayoutBox)LayoutBox.InvalidateMeasure()LayoutBox.IsRemovedLayoutBox.IsFragmentLayoutBox.AssociatedDocumentElementLayoutBox.ChildLayoutBoxesLayoutBox.BoundsChildBoxesLayoutBox.IsFirstBoxLayoutBox.IsLastBoxLayoutBox.IsFirstChildLayoutBox.IsLastChildLayoutBox.IsValidPositionLayoutBox.ParentLayoutBox.ChildIndexLayoutBox.BoundingRectangleLayoutBox.ElementStructureChangingLayoutBox.ElementStructureChangedLayoutElement.EnsureChildrenCreated()LayoutElement.CreateChildren()LayoutElement.OnBitStateChanged(DocumentElementStates, bool, bool)LayoutElement.SetBitState(DocumentElementStates, bool)LayoutElement.ValidateParent(LayoutElement)LayoutElement.SetParent(LayoutElement, LayoutElement)LayoutElement.SetParentCore(LayoutElement)LayoutElement.IsInValidState(bool)LayoutElement.OnInvalidateMeasure()LayoutElement.InvalidateMeasure(bool)LayoutElement.InvalidateArrange()LayoutElement.OnInvalidateArrange()LayoutElement.InvalidateArrange(bool)LayoutElement.Arrange(RectangleF)LayoutElement.ArrangeCore(RectangleF)LayoutElement.ArrangeOverride(SizeF)LayoutElement.Measure(SizeF)LayoutElement.MeasureCore(SizeF)LayoutElement.OnChildDesiredSizeChanged(LayoutElement)LayoutElement.OnParentChanging()LayoutElement.OnParentChanged()LayoutElement.LayoutOffsetLayoutElement.IsTopContainerLayoutElement.LocalBoundingRectangleLayoutElement.ControlBoundingRectangleLayoutElement.ClippedControlBoundingRectangleLayoutElement.TotalTransformLayoutElement.ChildrenLayoutElement.BitStateLayoutElement.DesiredSizeLayoutElement.IsMeasureInProgressLayoutElement.BypassLayoutPoliciesLayoutElement.MeasureWithoutParentNotificationLayoutElement.SizeLayoutElement.IsArrangeValidLayoutElement.IsMeasureValidLayoutElement.TreeLevelLayoutElement.PreviousArrangeRectLayoutElement.AlignmentLayoutElement.AutoSizeLayoutElement.TransformLayoutElement.ParentChangingLayoutElement.ParentChanged

Constructors

FormattingSymbolLayoutBox(DocumentElement, DocumentStructureCollection, FormattingSymbols)

Declaration

cs-api-definition
public FormattingSymbolLayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection, FormattingSymbols symbol)

Parameters

associatedDocumentElement

DocumentElement

collection

DocumentStructureCollection

symbol

FormattingSymbols

Fields

END_OF_CELL_SYMBOL_VISUAL

Declaration

cs-api-definition
public static readonly string END_OF_CELL_SYMBOL_VISUAL

Field Value

string

ENTER

Declaration

cs-api-definition
public static readonly string ENTER

Field Value

string

ENTER_SYMBOL_VISUAL

Declaration

cs-api-definition
public static readonly string ENTER_SYMBOL_VISUAL

Field Value

string

LINE_BREAK

Declaration

cs-api-definition
public static readonly string LINE_BREAK

Field Value

string

LINE_BREAK_VISUAL

Declaration

cs-api-definition
public static readonly string LINE_BREAK_VISUAL

Field Value

string

NON_BREAKING_SPACE_SYMBOL_VISUAL

Declaration

cs-api-definition
public static readonly string NON_BREAKING_SPACE_SYMBOL_VISUAL

Field Value

string

PAGE_BREAK

Declaration

cs-api-definition
public static readonly string PAGE_BREAK

Field Value

string

PAGE_BREAK_VISUAL

Declaration

cs-api-definition
public static readonly string PAGE_BREAK_VISUAL

Field Value

string

SPACE

Declaration

cs-api-definition
public static readonly string SPACE

Field Value

string

SPACE_SYMBOL_VISUAL

Declaration

cs-api-definition
public static readonly string SPACE_SYMBOL_VISUAL

Field Value

string

TAB

Declaration

cs-api-definition
public static readonly string TAB

Field Value

string

TAB_SYMBOL_VISUAL

Declaration

cs-api-definition
public static readonly string TAB_SYMBOL_VISUAL

Field Value

string

Properties

FormattingSymbol

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

Declaration

cs-api-definition
public FormattingSymbols FormattingSymbol { get; }

Property Value

FormattingSymbols

HasVisualRepresentation

Determines whether the formatting symbol has a visual representation.

Declaration

cs-api-definition
public override bool HasVisualRepresentation { get; }

Property Value

bool

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

Overrides LayoutBox.HasVisualRepresentation

HasWidthAtTheEndOfLine

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

Declaration

cs-api-definition
public override bool HasWidthAtTheEndOfLine { get; }

Property Value

bool

Overrides SpanLayoutBox.HasWidthAtTheEndOfLine

IsColumnBreak

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

Declaration

cs-api-definition
public bool IsColumnBreak { get; }

Property Value

bool

IsFormattingSymbol

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

Declaration

cs-api-definition
public override bool IsFormattingSymbol { get; }

Property Value

bool

Overrides LayoutBox.IsFormattingSymbol

IsLastOnLine

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

Declaration

cs-api-definition
public bool IsLastOnLine { get; }

Property Value

bool

IsLineBreak

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

Declaration

cs-api-definition
public bool IsLineBreak { get; }

Property Value

bool

IsPageBreak

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

Declaration

cs-api-definition
public bool IsPageBreak { get; }

Property Value

bool

IsParagraphEnd

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

Declaration

cs-api-definition
public bool IsParagraphEnd { get; }

Property Value

bool

IsReadonly

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

Declaration

cs-api-definition
public override bool IsReadonly { get; }

Property Value

bool

Overrides SpanLayoutBox.IsReadonly

IsSectionBreak

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

Declaration

cs-api-definition
public bool IsSectionBreak { get; }

Property Value

bool

IsSpace

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

Declaration

cs-api-definition
public bool IsSpace { get; }

Property Value

bool

IsSplittable

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

Declaration

cs-api-definition
public override bool IsSplittable { get; }

Property Value

bool

Overrides SpanLayoutBox.IsSplittable

IsTab

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

Declaration

cs-api-definition
public bool IsTab { get; }

Property Value

bool

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

PositionsCountInBox

Gets the count of positions contained within the layout box.

Declaration

cs-api-definition
public override int PositionsCountInBox { get; }

Property Value

int

Overrides SpanLayoutBox.PositionsCountInBox

Text

Represents the text content of the FormattingSymbolLayoutBox.

Declaration

cs-api-definition
public override string Text { get; set; }

Property Value

string

Overrides SpanLayoutBox.Text

Methods

CreateEnterSibling(SpanLayoutBox)

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

Declaration

cs-api-definition
public static FormattingSymbolLayoutBox CreateEnterSibling(SpanLayoutBox siblingSpan)

Parameters

siblingSpan

SpanLayoutBox

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

cs-api-definition
public static FormattingSymbolLayoutBox CreateFormattingSymbolSibling(SpanLayoutBox siblingSpan, FormattingSymbols symbol)

Parameters

siblingSpan

SpanLayoutBox

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

symbol

FormattingSymbols

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

cs-api-definition
public static FormattingSymbolLayoutBox CreateSpaceSibling(SpanLayoutBox siblingSpan)

Parameters

siblingSpan

SpanLayoutBox

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

cs-api-definition
public static FormattingSymbolLayoutBox CreateTabSibling(SpanLayoutBox siblingSpan)

Parameters

siblingSpan

SpanLayoutBox

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

cs-api-definition
public int GetFormattingHashCode(Span span)

Parameters

span

Span

The span for which to calculate the formatting hash code.

Returns

int

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

MeasureTextOverride(SubStringPosition)

Declaration

cs-api-definition
protected override BoxMeasurementInfo MeasureTextOverride(SubStringPosition subStringPosition = 0)

Parameters

subStringPosition

SubStringPosition

Returns

BoxMeasurementInfo

Overrides SpanLayoutBox.MeasureTextOverride(SubStringPosition)

In this article
DefinitionConstructorsFormattingSymbolLayoutBox(DocumentElement, DocumentStructureCollection, FormattingSymbols)FieldsEND_OF_CELL_SYMBOL_VISUALENTERENTER_SYMBOL_VISUALLINE_BREAKLINE_BREAK_VISUALNON_BREAKING_SPACE_SYMBOL_VISUALPAGE_BREAKPAGE_BREAK_VISUALSPACESPACE_SYMBOL_VISUALTABTAB_SYMBOL_VISUALPropertiesFormattingSymbolHasVisualRepresentationHasWidthAtTheEndOfLineIsColumnBreakIsFormattingSymbolIsLastOnLineIsLineBreakIsPageBreakIsParagraphEndIsReadonlyIsSectionBreakIsSpaceIsSplittableIsTabPositionsCountInBoxTextMethodsCreateEnterSibling(SpanLayoutBox)CreateFormattingSymbolSibling(SpanLayoutBox, FormattingSymbols)CreateSpaceSibling(SpanLayoutBox)CreateTabSibling(SpanLayoutBox)GetFormattingHashCode(Span)MeasureTextOverride(SubStringPosition)
Not finding the help you need?
Contact Support