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

Provides the shared layout-box and formatting-change tracking used by formatting-symbol and tab-leader visuals.

Definition

Namespace:Telerik.WinForms.Documents.UI.UIProviders

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public abstract class FormattingSymbolUIProviderBase : IUIProvider

Inheritance: objectFormattingSymbolUIProviderBase

Derived Classes: FormattingSymbolUIProviderTabLeaderSymbolUIProvider

Implements: IUIProvider

Constructors

C#
protected FormattingSymbolUIProviderBase()

Properties

Gets or sets the paragraph whose relevant formatting changes can invalidate the visual.

C#
protected Paragraph AssociatedParagraph { get; set; }

Gets or sets the span whose formatting changes can invalidate the visual; changing it updates the observed span.

C#
protected Span AssociatedSpan { get; set; }

Gets the layout bounds of the formatting-symbol box represented by this provider.

C#
public RectangleF BoundingRectangle { get; }

Implements: IUIProvider.BoundingRectangle

Gets or sets the layer that hosts this provider's visual marker.

C#
public IUILayer ContainingLayer { get; set; }

Implements: IUIProvider.ContainingLayer

Gets the layer-update context most recently supplied when creating the provider's visual.

C#
public UILayerUpdateContext CurrentUpdateContext { get; protected set; }

Gets or sets the formatting-symbol layout box represented by this provider.

C#
public FormattingSymbolLayoutBox FormattingSymbolBox { get; protected set; }

Gets whether observed formatting changes require the provider's visual to be recreated.

C#
public virtual bool IsInvalidated { get; }

Implements: IUIProvider.IsInvalidated

Gets or sets the invalidation state set by observed formatting changes or derived-provider checks.

C#
protected bool IsInvalidatedFlag { get; set; }

Gets whether the underlying formatting-symbol box has been removed from the layout.

C#
public bool IsRemoved { get; }

Implements: IUIProvider.IsRemoved

Methods

Positions the provider's visual elements within the current view.

C#
public abstract void Arrange(UILayerUpdateContext uILayerUpdateContext)
Parameters:uILayerUpdateContextUILayerUpdateContext

The current layer context.

Implements: IUIProvider.Arrange(UILayerUpdateContext)

Creates or retrieves the UI elements representing the formatting symbol.

C#
public abstract IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)
Parameters:contextUILayerUpdateContext

The current layer context.

Returns:

IEnumerable<UIElement>

The UI elements to host in the containing layer.

Implements: IUIProvider.GetUIElements(UILayerUpdateContext)

Releases any visual elements created by the provider.

C#
public abstract void ReleaseElements()

Implements: IUIProvider.ReleaseElements()

Does nothing in the base implementation; providers can override it to refresh their visual.

C#
public virtual void UpdateUI(UILayerUpdateContext uILayerUpdateContext)
Parameters:uILayerUpdateContextUILayerUpdateContext

The current layer context.

Implements: IUIProvider.UpdateUI(UILayerUpdateContext)