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

BackgroundUIProvider

Class

Provides background UI functionalities for Telerik documents.

Definition

Namespace:Telerik.Windows.Documents.UI.UIProviders

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

public class BackgroundUIProvider : IUIProvider

Inheritance: objectBackgroundUIProvider

Implements: IUIProvider

Constructors

BackgroundUIProvider(LayoutBox)

public BackgroundUIProvider(LayoutBox layoutBox)

Parameters:layoutBoxLayoutBox

Properties

BackgroundUI

Rectangle

Gets the background UI associated with the current instance of the BackgroundUIProvider.

public Rectangle BackgroundUI { get; }

BoundingRectangle

RectangleF

Gets the bounding rectangle for the background UI provider, which defines the area for rendering backgrounds.

public RectangleF BoundingRectangle { get; }

Property Value:

A Rect structure representing the dimensions of the bounding rectangle.

Implements: IUIProvider.BoundingRectangle

ContainingLayer

IUILayer

Gets the containing layer for the background UI provider.

public IUILayer ContainingLayer { get; set; }

Property Value:

The layer that contains the background UI elements.

Implements: IUIProvider.ContainingLayer

CurrentUpdateContext

UILayerUpdateContext

Gets the current update context for the Background UI Provider. This context is used to manage the state and updates of UI elements within the Background UI.

public UILayerUpdateContext CurrentUpdateContext { get; }

IsInvalidated

bool

Gets a value indicating whether the background UI provider is invalidated.

public bool IsInvalidated { get; protected set; }

Implements: IUIProvider.IsInvalidated

IsRemoved

bool

Gets a value indicating whether the background UI element has been removed.

public bool IsRemoved { get; }

Implements: IUIProvider.IsRemoved

LayoutBox

Represents a layout box used by the BackgroundUIProvider to manage the arrangement of UI elements.

public LayoutBox LayoutBox { get; }

Methods

Arrange(UILayerUpdateContext)

Arranges the background UI elements based on the specified update context.

public void Arrange(UILayerUpdateContext uILayerUpdateContext)

Parameters:uILayerUpdateContextUILayerUpdateContext

The update context containing information about the UI layer updates.

Implements: IUIProvider.Arrange(UILayerUpdateContext)

GetUIElements(UILayerUpdateContext)

IEnumerable<UIElement>

Retrieves the UI elements associated with the specified update context.

public IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)

Parameters:contextUILayerUpdateContext

The context that provides information about the UI layer update.

Returns:

IEnumerable<UIElement>

A collection of UI elements that have been updated in the specified context.

Implements: IUIProvider.GetUIElements(UILayerUpdateContext)

ReleaseElements()

Releases the elements managed by the BackgroundUIProvider.

public void ReleaseElements()

Implements: IUIProvider.ReleaseElements()

UpdateUI(UILayerUpdateContext)

Updates the user interface elements based on the specified update context.

public virtual void UpdateUI(UILayerUpdateContext uILayerUpdateContext)

Parameters:uILayerUpdateContextUILayerUpdateContext

The context containing the information needed to update the UI elements.

Implements: IUIProvider.UpdateUI(UILayerUpdateContext)