New to Telerik UI for WPFStart a free 30-day trial

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

Definition

Namespace:Telerik.Windows.Documents.Layout

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

C#
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

C#
public FormattingSymbolLayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection, FormattingSymbols symbol)
Parameters:associatedDocumentElementDocumentElementcollectionDocumentStructureCollectionsymbolFormattingSymbols

Fields

C#
public static readonly string END_OF_CELL_SYMBOL_VISUAL
C#
public static readonly string ENTER
C#
public static readonly string ENTER_SYMBOL_VISUAL
C#
public static readonly string LINE_BREAK
C#
public static readonly string LINE_BREAK_VISUAL
C#
public static readonly string NON_BREAKING_SPACE_SYMBOL_VISUAL
C#
public static readonly string PAGE_BREAK
C#
public static readonly string PAGE_BREAK_VISUAL
C#
public static readonly string SPACE
C#
public static readonly string SPACE_SYMBOL_VISUAL
C#
public static readonly string TAB
C#
public static readonly string TAB_SYMBOL_VISUAL

Properties

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

C#
public FormattingSymbols FormattingSymbol { get; }

Determines whether the formatting symbol has a visual representation.

C#
public override bool HasVisualRepresentation { get; }
Property Value:

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

Overrides: LayoutBox.HasVisualRepresentation

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

C#
public override bool HasWidthAtTheEndOfLine { get; }

Overrides: SpanLayoutBox.HasWidthAtTheEndOfLine

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

C#
public bool IsColumnBreak { get; }

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

C#
public override bool IsFormattingSymbol { get; }

Overrides: LayoutBox.IsFormattingSymbol

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

C#
public bool IsLastOnLine { get; }

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

C#
public bool IsLineBreak { get; }

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

C#
public bool IsPageBreak { get; }

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

C#
public bool IsParagraphEnd { get; }

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

C#
public override bool IsReadonly { get; }

Overrides: SpanLayoutBox.IsReadonly

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

C#
public bool IsSectionBreak { get; }

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

C#
public bool IsSpace { get; }

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

C#
public override bool IsSplittable { get; }

Overrides: SpanLayoutBox.IsSplittable

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

C#
public bool IsTab { get; }
Property Value:

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

Gets the count of positions contained within the layout box.

C#
public override int PositionsCountInBox { get; }

Overrides: SpanLayoutBox.PositionsCountInBox

Represents the text content of the FormattingSymbolLayoutBox.

C#
public override string Text { get; set; }

Overrides: SpanLayoutBox.Text

Methods

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

C#
public static FormattingSymbolLayoutBox CreateEnterSibling(SpanLayoutBox siblingSpan)
Parameters:siblingSpanSpanLayoutBox

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.

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

C#
public static FormattingSymbolLayoutBox CreateFormattingSymbolSibling(SpanLayoutBox siblingSpan, FormattingSymbols symbol)
Parameters:siblingSpanSpanLayoutBox

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

symbolFormattingSymbols

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.

Creates a space sibling for the specified SpanLayoutBox instance.

C#
public static FormattingSymbolLayoutBox CreateSpaceSibling(SpanLayoutBox siblingSpan)
Parameters:siblingSpanSpanLayoutBox

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

Returns:

FormattingSymbolLayoutBox

Returns a new instance of FormattingSymbolLayoutBox representing the space sibling.

Creates a tab sibling for the specified SpanLayoutBox.

C#
public static FormattingSymbolLayoutBox CreateTabSibling(SpanLayoutBox siblingSpan)
Parameters:siblingSpanSpanLayoutBox

The SpanLayoutBox to create a tab sibling for.

Returns:

FormattingSymbolLayoutBox

A new instance of FormattingSymbolLayoutBox that represents the tab sibling.

Gets the formatting hash code for the specified span.

C#
public int GetFormattingHashCode(Span span)
Parameters:spanSpan

The span for which to calculate the formatting hash code.

Returns:

int

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

C#
protected override BoxMeasurementInfo MeasureTextOverride(SubStringPosition subStringPosition = 0)
Parameters:subStringPositionSubStringPositionReturns:

BoxMeasurementInfo

Overrides: SpanLayoutBox.MeasureTextOverride(SubStringPosition)