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

Provides the page or web-layout surface associated with a section layout box.

Definition

Namespace:Telerik.WinForms.Documents.UI.UIProviders

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public class PageUIProvider : IUIProvider

Inheritance: objectPageUIProvider

Implements: IUIProvider

Constructors

Initializes a provider for the specified section layout box.

C#
public PageUIProvider(SectionLayoutBox sectionBox)
Parameters:sectionBoxSectionLayoutBox

The section whose surface should be displayed.

Properties

Gets the section layout bounds represented by this provider.

C#
public RectangleF BoundingRectangle { get; }

Implements: IUIProvider.BoundingRectangle

Gets or sets the layer that hosts the page surface.

C#
public IUILayer ContainingLayer { get; set; }

Implements: IUIProvider.ContainingLayer

Gets the most recently supplied layer-update context.

C#
public UILayerUpdateContext CurrentUpdateContext { get; }

Gets whether the page surface is invalidated; this provider always returns false.

C#
public bool IsInvalidated { get; }

Implements: IUIProvider.IsInvalidated

Gets whether the section layout box has been removed.

C#
public bool IsRemoved { get; }

Implements: IUIProvider.IsRemoved

Gets the section layout box for which the page surface is created.

C#
public SectionLayoutBox SectionBox { get; }

Gets the pooled page or web-layout visual.

C#
public SectionUIBase SectionUI { get; }

Methods

Sizes the visual to its presenter outside paged layout; page presenters size it during UpdateUI(UILayerUpdateContext).

C#
public void Arrange(UILayerUpdateContext uILayerUpdateContext)
Parameters:uILayerUpdateContextUILayerUpdateContext

The current layer context.

Implements: IUIProvider.Arrange(UILayerUpdateContext)

Creates the page or web-layout visual on first use and applies the owner's page background color.

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

The current layer context.

Returns:

IEnumerable<UIElement>

The section's page or web-layout visual.

Implements: IUIProvider.GetUIElements(UILayerUpdateContext)

Returns the page or web-layout visual to the object pool.

C#
public void ReleaseElements()

Implements: IUIProvider.ReleaseElements()

Updates page dimensions and border visibility when hosted by a page presenter.

C#
public virtual void UpdateUI(UILayerUpdateContext uILayerUpdateContext)
Parameters:uILayerUpdateContextUILayerUpdateContext

The current layer context.

Implements: IUIProvider.UpdateUI(UILayerUpdateContext)