Class
PageUIProvider

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:

cs-api-definition
public class PageUIProvider : IUIProvider

Inheritance: objectPageUIProvider

Implements: IUIProvider

Constructors

PageUIProvider(SectionLayoutBox)

Declaration

cs-api-definition
public PageUIProvider(SectionLayoutBox sectionBox)

Parameters

sectionBox

SectionLayoutBox

Properties

BoundingRectangle

Gets the bounding rectangle of the page UI provider, which defines the area occupied by the UI elements.

Declaration

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

Property Value

RectangleF

Implements IUIProvider.BoundingRectangle

ContainingLayer

Gets the layer that contains the page UI elements.

Declaration

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

Property Value

IUILayer

Implements IUIProvider.ContainingLayer

CurrentUpdateContext

Gets the current update context of the Page UI Provider.

Declaration

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

Property Value

UILayerUpdateContext

IsInvalidated

Gets a value indicating whether the Page UI Provider is invalidated.

Declaration

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

Property Value

bool

Implements IUIProvider.IsInvalidated

IsRemoved

Gets a value indicating whether the page has been removed from the UI provider.

Declaration

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

Property Value

bool

true if the page is removed; otherwise, false.

Implements IUIProvider.IsRemoved

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

cs-api-definition
public SectionLayoutBox SectionBox { get; }

Property Value

SectionLayoutBox

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.

Declaration

cs-api-definition
public SectionUIBase SectionUI { get; }

Property Value

SectionUIBase

Methods

Arrange(UILayerUpdateContext)

Arranges the UI elements within the specified update context for the page provider.

Declaration

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

Parameters

uILayerUpdateContext

UILayerUpdateContext

The context containing information about the UI layer update.

Implements IUIProvider.Arrange(UILayerUpdateContext)

GetUIElements(UILayerUpdateContext)

Retrieves a collection of UI 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 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 IUIProvider.GetUIElements(UILayerUpdateContext)

ReleaseElements()

Releases all elements associated with the PageUIProvider.

Declaration

cs-api-definition
public void ReleaseElements()

Implements IUIProvider.ReleaseElements()

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

cs-api-definition
public virtual void UpdateUI(UILayerUpdateContext uILayerUpdateContext)

Parameters

uILayerUpdateContext

UILayerUpdateContext

The update context that contains information about the layers that need to be refreshed.

Implements IUIProvider.UpdateUI(UILayerUpdateContext)