ClassBackgroundUIProvider
Provides background UI functionalities for Telerik documents.
Definition
Namespace:Telerik.Windows.Documents.UI.UIProviders
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class BackgroundUIProvider : IUIProviderInheritance: objectBackgroundUIProvider
Implements:
Constructors
BackgroundUIProvider(LayoutBox)
Declaration
public BackgroundUIProvider(LayoutBox layoutBox)Parameters
layoutBox
Properties
BackgroundUI
Gets the background UI associated with the current instance of the BackgroundUIProvider.
Declaration
public Rectangle BackgroundUI { get; }Property Value
Rectangle
BoundingRectangle
Gets the bounding rectangle for the background UI provider, which defines the area for rendering backgrounds.
Declaration
public RectangleF BoundingRectangle { get; }Property Value
A Rect structure representing the dimensions of the bounding rectangle.
Implements
ContainingLayer
Gets the containing layer for the background UI provider.
Declaration
public IUILayer ContainingLayer { get; set; }Property Value
The layer that contains the background UI elements.
Implements
CurrentUpdateContext
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.
Declaration
public UILayerUpdateContext CurrentUpdateContext { get; }Property Value
IsInvalidated
Gets a value indicating whether the background UI provider is invalidated.
Declaration
public bool IsInvalidated { get; protected set; }Property Value
Implements
IsRemoved
Gets a value indicating whether the background UI element has been removed.
Methods
Arrange(UILayerUpdateContext)
Arranges the background UI elements based on the specified update context.
Declaration
public void Arrange(UILayerUpdateContext uILayerUpdateContext)Parameters
uILayerUpdateContext
The update context containing information about the UI layer updates.
Implements
GetUIElements(UILayerUpdateContext)
Retrieves the UI elements associated with the specified update context.
Declaration
public IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)Parameters
context
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
ReleaseElements()
Releases the elements managed by the BackgroundUIProvider.
Declaration
public void ReleaseElements()Implements
UpdateUI(UILayerUpdateContext)
Updates the user interface elements based on the specified update context.
Declaration
public virtual void UpdateUI(UILayerUpdateContext uILayerUpdateContext)Parameters
uILayerUpdateContext
The context containing the information needed to update the UI elements.
Implements