Class
FormattingSymbolUIProviderBase

Provides the base class for formatting symbol UI providers in the Telerik Windows Documents UI framework.

Definition

Namespace:Telerik.Windows.Documents.UI.UIProviders

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public abstract class FormattingSymbolUIProviderBase : IUIProvider

Inheritance: objectFormattingSymbolUIProviderBase

Derived Classes: FormattingSymbolUIProviderTabLeaderSymbolUIProvider

Implements: IUIProvider

Constructors

FormattingSymbolUIProviderBase()

Declaration

cs-api-definition
protected FormattingSymbolUIProviderBase()

Properties

AssociatedParagraph

Declaration

cs-api-definition
protected Paragraph AssociatedParagraph { get; set; }

Property Value

Paragraph

AssociatedSpan

Declaration

cs-api-definition
protected Span AssociatedSpan { get; set; }

Property Value

Span

BoundingRectangle

Gets the bounding rectangle for the formatting symbol UI provider.

Declaration

cs-api-definition
public RectangleF BoundingRectangle { get; }

Property Value

RectangleF

Implements IUIProvider.BoundingRectangle

ContainingLayer

Gets the layer that contains the formatting symbols.

Declaration

cs-api-definition
public IUILayer ContainingLayer { get; set; }

Property Value

IUILayer

Implements IUIProvider.ContainingLayer

CurrentUpdateContext

Gets the current update context for the formatting symbol UI provider.

Declaration

cs-api-definition
public UILayerUpdateContext CurrentUpdateContext { get; protected set; }

Property Value

UILayerUpdateContext

FormattingSymbolBox

Represents a box that displays formatting symbols in the UI.

Declaration

cs-api-definition
public FormattingSymbolLayoutBox FormattingSymbolBox { get; protected set; }

Property Value

FormattingSymbolLayoutBox

IsInvalidated

Gets a value indicating whether the formatting symbol UI provider is invalidated.

Declaration

cs-api-definition
public virtual bool IsInvalidated { get; }

Property Value

bool

Implements IUIProvider.IsInvalidated

IsInvalidatedFlag

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Naming", "CA1726:UsePreferredTerms", MessageId = "Flag")]
protected bool IsInvalidatedFlag { get; set; }

Property Value

bool

IsRemoved

Gets a value indicating whether the formatting symbol has been removed.

Declaration

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

Property Value

bool

True if the formatting symbol is removed; otherwise, false.

Implements IUIProvider.IsRemoved

Methods

Arrange(UILayerUpdateContext)

Arranges the formatting symbols based on the specified UI layer update context.

Declaration

cs-api-definition
public abstract void Arrange(UILayerUpdateContext uILayerUpdateContext)

Parameters

uILayerUpdateContext

UILayerUpdateContext

The context for updating the UI layer, which contains information about the current state and updates to be applied.

Implements IUIProvider.Arrange(UILayerUpdateContext)

GetUIElements(UILayerUpdateContext)

Retrieves the user interface elements associated with formatting symbols.

Declaration

cs-api-definition
public abstract IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)

Parameters

context

UILayerUpdateContext

The update context for the user interface layer, providing information about the current state and updates required.

Returns

IEnumerable<UIElement>

A collection of UI elements representing the formatting symbols in the document.

Implements IUIProvider.GetUIElements(UILayerUpdateContext)

ReleaseElements()

Releases the resources used by the formatting symbol UI provider.

Declaration

cs-api-definition
public abstract void ReleaseElements()

Implements IUIProvider.ReleaseElements()

UpdateUI(UILayerUpdateContext)

Updates the user interface based on the specified update context.

Declaration

cs-api-definition
public virtual void UpdateUI(UILayerUpdateContext uILayerUpdateContext)

Parameters

uILayerUpdateContext

UILayerUpdateContext

The context that contains information for updating the UI.

Implements IUIProvider.UpdateUI(UILayerUpdateContext)