ClassPageUIProvider
Represents a provider for user interface elements associated with pages in the document model.
Definition
Namespace:Telerik.Windows.Documents.UI.UIProviders
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class PageUIProvider : IUIProvider
Inheritance: objectPageUIProvider
Implements:
Constructors
PageUIProvider(SectionLayoutBox)
Declaration
public PageUIProvider(SectionLayoutBox sectionBox)
Parameters
sectionBox
Properties
BoundingRectangle
Gets the bounding rectangle of the page UI provider, which defines the area occupied by the UI elements.
Declaration
public RectangleF BoundingRectangle { get; }
Property Value
Implements
ContainingLayer
Gets the layer that contains the page UI elements.
Declaration
public IUILayer ContainingLayer { get; set; }
Property Value
Implements
CurrentUpdateContext
Gets the current update context of the Page UI Provider.
Declaration
public UILayerUpdateContext CurrentUpdateContext { get; }
Property Value
IsInvalidated
Gets a value indicating whether the Page UI Provider is invalidated.
IsRemoved
Gets a value indicating whether the page has been removed from the UI provider.
Declaration
public bool IsRemoved { get; }
Property Value
true if the page is removed; otherwise, false.
Implements
SectionBox
Represents a SectionBox element in the PageUIProvider for UI rendering purposes. This element is responsible for providing the visual representation of sections within the document interface, enabling better management and organization of content.
Declaration
public SectionLayoutBox SectionBox { get; }
Property Value
SectionUI
Represents the Section UI within the Page UI provider in Telerik's document management framework. This class is responsible for managing and displaying section-related user interface elements in the document viewer.
Methods
Arrange(UILayerUpdateContext)
Arranges the UI elements within the specified update context for the page provider.
Declaration
public void Arrange(UILayerUpdateContext uILayerUpdateContext)
Parameters
uILayerUpdateContext
The context containing information about the UI layer update.
Implements
GetUIElements(UILayerUpdateContext)
Retrieves a collection of UI elements associated with the specified UI layer update context.
Declaration
public IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)
Parameters
context
The context that contains information about the current update for the UI layer.
Returns
IEnumerable<UIElement>
A collection of UI elements represented by the specified update context.
Implements
ReleaseElements()
Releases all elements associated with the PageUIProvider.
Declaration
public void ReleaseElements()
Implements
Remarks
This method cleans up resources and ensures that all UI elements are properly disposed of.
UpdateUI(UILayerUpdateContext)
Updates the user interface based on the provided update context. This method refreshes the UI elements to reflect any changes in the underlying data model.
Declaration
public virtual void UpdateUI(UILayerUpdateContext uILayerUpdateContext)
Parameters
uILayerUpdateContext
The update context that contains information about the layers that need to be refreshed.
Implements