Class
NoteUIProviderBase

Represents the base class for UI providers that handle note-related operations in Telerik's document framework.

Definition

Namespace:Telerik.Windows.Documents.UI.UIProviders

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public abstract class NoteUIProviderBase : IUIProvider

Inheritance: objectNoteUIProviderBase

Derived Classes: EndnoteUIProviderFootnoteUIProvider

Implements: IUIProvider

Constructors

NoteUIProviderBase()

Declaration

cs-api-definition
protected NoteUIProviderBase()

Properties

BoundingRectangle

Gets the bounding rectangle of the note UI element.

Declaration

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

Property Value

RectangleF

Implements IUIProvider.BoundingRectangle

ContainingLayer

Gets the containing layer of the Note UI provider.

Declaration

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

Property Value

IUILayer

Implements IUIProvider.ContainingLayer

CurrentUpdateContext

Gets the current update context associated with the Note UI provider.

Declaration

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

Property Value

UILayerUpdateContext

Editor

Declaration

cs-api-definition
protected RadRichTextBox Editor { get; }

Property Value

RadRichTextBox

IsInvalidated

Gets a value indicating whether the Note UI Provider has been invalidated.

Declaration

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

Property Value

bool

Implements IUIProvider.IsInvalidated

IsRemoved

Gets a value indicating whether the note has been removed.

Declaration

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

Property Value

bool

Implements IUIProvider.IsRemoved

Note

Declaration

cs-api-definition
protected abstract Note Note { get; }

Property Value

Note

Methods

Arrange(UILayerUpdateContext)

Arranges the user interface elements for the note provider based on the specified update context.

Declaration

cs-api-definition
public void Arrange(UILayerUpdateContext context)

Parameters

context

UILayerUpdateContext

The context that provides information for updating the UI layer.

Implements IUIProvider.Arrange(UILayerUpdateContext)

GetUIElements(UILayerUpdateContext)

Retrieves the user interface elements associated with the specified UI layer update context.

Declaration

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

Parameters

context

UILayerUpdateContext

The context that provides information for updating the UI layer.

Returns

IEnumerable<UIElement>

An enumerable collection of UI elements that are part of the specified update context.

Implements IUIProvider.GetUIElements(UILayerUpdateContext)

ReleaseElements()

Releases the resources used by the note UI provider, performing any necessary cleanup operations.

Declaration

cs-api-definition
public void ReleaseElements()

Implements IUIProvider.ReleaseElements()

UpdateUI(UILayerUpdateContext)

Updates the user interface based on the provided context during a note operation.

Declaration

cs-api-definition
public void UpdateUI(UILayerUpdateContext context)

Parameters

context

UILayerUpdateContext

The context containing information about the current UI layer update.

Implements IUIProvider.UpdateUI(UILayerUpdateContext)