New to Telerik UI for WinForms? Start a free 30-day trial

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:

C#
public class FormattingSymbolLayoutBox : SpanLayoutBox, IDisposable, ICustomTypeDescriptor, INotifyPropertyChanged

Inheritance: objectDisposableObjectRadObjectLayoutElementLayoutBoxInlineLayoutBoxSpanLayoutBoxFormattingSymbolLayoutBox...

Implements: ICustomTypeDescriptorIDisposableINotifyPropertyChanged

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.ParentChangedRadObject.BindingContextPropertyRadObject.RadTypeRadObject.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadObject.DisposeManagedResources()RadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.GetValue(RadProperty)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.SetValueCore(RadPropertyValue, object, object, ValueSource)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.CanRaisePropertyChangeNotifications(RadPropertyValue)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.AddStylePropertySetting(IPropertySetting)RadObject.GetInheritedValue(RadProperty)RadObject.OnPropertyChanging(RadPropertyChangingEventArgs)RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)RadObject.OnNotifyPropertyChanged(string)RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.IsPropertyCancelable(RadPropertyMetadata)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.PerformDispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing...

Constructors

Initializes a formatting-symbol box for the specified document element and symbol kind.

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

The document element associated with the symbol.

collectionDocumentStructureCollection

The document structure collection that owns the box.

symbolFormattingSymbols

The formatting-symbol kind represented by the box.

Fields

Gets the currency-sign glyph used to display an end-of-cell marker.

C#
public static readonly string END_OF_CELL_SYMBOL_VISUAL

Gets the platform newline string used for a paragraph-ending marker.

C#
public static readonly string ENTER

Gets the pilcrow glyph used to display a paragraph-ending marker.

C#
public static readonly string ENTER_SYMBOL_VISUAL

Gets the not-sign character used as the layout token for a line break.

C#
public static readonly string LINE_BREAK

Gets the not-sign glyph used to display a line break.

C#
public static readonly string LINE_BREAK_VISUAL

Gets the degree-sign glyph used to display a non-breaking space.

C#
public static readonly string NON_BREAKING_SPACE_SYMBOL_VISUAL

Gets the lozenge character used as the layout token for a page break.

C#
public static readonly string PAGE_BREAK

Gets the lozenge glyph used to display a page break.

C#
public static readonly string PAGE_BREAK_VISUAL

Gets the regular space character used as the layout token for a space.

C#
public static readonly string SPACE

Gets the text representation returned for a regular space formatting symbol.

C#
public static readonly string SPACE_SYMBOL_VISUAL

Gets the horizontal tab character used as the layout token for a tab.

C#
public static readonly string TAB

Gets the right-arrow glyph used to display a tab.

C#
public static readonly string TAB_SYMBOL_VISUAL

Properties

Gets the formatting-symbol kind represented by this box.

C#
public FormattingSymbols FormattingSymbol { get; }

Gets whether the symbol has a visual representation; the current implementation always returns true.

C#
public override bool HasVisualRepresentation { get; }

Overrides: LayoutBox.HasVisualRepresentation

Gets whether a tab or non-breaking space contributes width at the end of a line.

C#
public override bool HasWidthAtTheEndOfLine { get; }

Overrides: SpanLayoutBox.HasWidthAtTheEndOfLine

Gets whether this box represents a column break.

C#
public bool IsColumnBreak { get; }

Gets whether this box represents a formatting symbol rather than editable span text.

C#
public override bool IsFormattingSymbol { get; }

Overrides: LayoutBox.IsFormattingSymbol

Gets whether this is an end-of-line marker: a paragraph end, page break, line break, or column break.

C#
public bool IsLastOnLine { get; }

Gets whether this box represents a line break or vertical tab.

C#
public bool IsLineBreak { get; }

Gets whether this box represents a page break.

C#
public bool IsPageBreak { get; }

Gets whether this box represents a paragraph-ending Enter marker.

C#
public bool IsParagraphEnd { get; }

Gets whether this symbol's text is read-only.

C#
public override bool IsReadonly { get; }

Overrides: SpanLayoutBox.IsReadonly

Gets whether this paragraph-ending marker closes the final layout fragment of a section followed by another section.

C#
public bool IsSectionBreak { get; }

Gets whether this box represents a regular or non-breaking space.

C#
public bool IsSpace { get; }

Gets whether this symbol can be split into multiple layout fragments; formatting symbols cannot be split.

C#
public override bool IsSplittable { get; }

Overrides: SpanLayoutBox.IsSplittable

Gets whether this box represents a tab.

C#
public bool IsTab { get; }

Gets the single document position represented by this formatting symbol.

C#
public override int PositionsCountInBox { get; }

Overrides: SpanLayoutBox.PositionsCountInBox

Gets the glyph used to display this symbol. Setting the text is not supported.

C#
public override string Text { get; set; }
Exceptions: InvalidOperationException

The text of a formatting symbol cannot be set.

Overrides: SpanLayoutBox.Text

Methods

Creates an unattached paragraph-ending formatting-symbol box associated with the supplied span box.

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

The span box whose document association and collection are reused.

Returns:

FormattingSymbolLayoutBox

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.

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

The span box whose document association and collection are reused.

symbolFormattingSymbols

The formatting-symbol kind to represent.

Returns:

FormattingSymbolLayoutBox

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.

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

The span box whose document association and collection are reused.

Returns:

FormattingSymbolLayoutBox

A new box; it is not inserted into the layout tree.

Creates an unattached tab formatting-symbol box associated with the supplied span box.

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

The span box whose document association and collection are reused.

Returns:

FormattingSymbolLayoutBox

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.

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

The span whose formatting affects the marker's measured size.

Returns:

int

A hash used to look up cached formatting-symbol measurements.

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.

C#
protected override BoxMeasurementInfo MeasureTextOverride(SubStringPosition subStringPosition = SubStringPosition.None)
Parameters:subStringPositionSubStringPosition

Ignored because a formatting marker is measured as a complete glyph.

Returns:

BoxMeasurementInfo

The measured size and baseline information for the marker.

Overrides: SpanLayoutBox.MeasureTextOverride(SubStringPosition)