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

Hosts a note body in a pooled child editor and synchronizes its editing state with the owning document editor.

Definition

Namespace:Telerik.WinForms.Documents.UI.UIProviders

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public abstract class NoteUIProviderBase : IUIProvider

Inheritance: objectNoteUIProviderBase

Derived Classes: EndnoteUIProviderFootnoteUIProvider

Implements: IUIProvider

Constructors

C#
protected NoteUIProviderBase()

Properties

Gets the containing section's bounds, or an offscreen rectangle when note layout information is unavailable.

C#
public RectangleF BoundingRectangle { get; }

Implements: IUIProvider.BoundingRectangle

Gets or sets the layer currently hosting this provider; the layer clears this association when detaching it.

C#
public IUILayer ContainingLayer { get; set; }

Implements: IUIProvider.ContainingLayer

Gets the most recent layer context used to locate this note and its owner.

C#
public UILayerUpdateContext CurrentUpdateContext { get; }

Gets the child editor displaying the note body.

C#
protected RadRichTextBox Editor { get; }

Gets whether a current update context exists but no layout information can be found for the note.

C#
public bool IsInvalidated { get; }

Implements: IUIProvider.IsInvalidated

Gets whether the note's source range or layout box has been removed.

C#
public abstract bool IsRemoved { get; }

Implements: IUIProvider.IsRemoved

Gets the note whose body is displayed by this provider.

C#
protected abstract Note Note { get; }

Methods

Positions and sizes the child editor from the note's layout information and the view offset.

C#
public void Arrange(UILayerUpdateContext context)
Parameters:contextUILayerUpdateContext

The current layer context.

Implements: IUIProvider.Arrange(UILayerUpdateContext)

Gets the note-body editor visual, creating and binding the pooled editor on the first request.

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

The layer context that supplies the owner and object pool.

Returns:

IEnumerable<UIElement>

The child editor visual to add to the layer.

Implements: IUIProvider.GetUIElements(UILayerUpdateContext)

Detaches editor event handlers, clears the child editor's document, and returns it to the object pool.

C#
public void ReleaseElements()

Implements: IUIProvider.ReleaseElements()

Updates the context and focuses the child editor when its note is the owner's selected note.

C#
public void UpdateUI(UILayerUpdateContext context)
Parameters:contextUILayerUpdateContext

The current layer context.

Implements: IUIProvider.UpdateUI(UILayerUpdateContext)