Class
DocumentPagePresenter

Represents a presenter for displaying document pages within the Telerik UI framework.

Definition

Namespace:Telerik.Windows.Documents.UI

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class DocumentPagePresenter : ContentControl, IUILayerContainer

Inheritance: objectDocumentPagePresenter

Implements: IUILayerContainer

Constructors

DocumentPagePresenter()

Declaration

cs-api-definition
public DocumentPagePresenter()

Properties

CaretTextInputHandler

Gets or sets the CaretTextInputHandler that handles the input of the caret.

Declaration

cs-api-definition
public CaretTextInputHandler CaretTextInputHandler { get; set; }

Property Value

CaretTextInputHandler

Owner

Gets or sets the owner of the DocumentPagePresenter.

Declaration

cs-api-definition
public IDocumentEditorPresenterContainer Owner { get; }

Property Value

IDocumentEditorPresenterContainer

The owner of the DocumentPagePresenter, which can be used to access the associated document or parent component.

Implements IUILayerContainer.Owner

PageCanvas

Gets the canvas element that represents the page in the document presenter.

Declaration

cs-api-definition
public Panel PageCanvas { get; }

Property Value

Panel

SectionBoxIndex

Gets the index of the SectionBox within the DocumentPagePresenter.

Declaration

cs-api-definition
public int SectionBoxIndex { get; set; }

Property Value

int

The zero-based index of the SectionBox. Returns -1 if the SectionBox does not exist.

UILayers

Gets or sets the UI layers of the document page presenter.

Declaration

cs-api-definition
public UILayerStack UILayers { get; }

Property Value

UILayerStack

A collection of UI layers that represent various elements in the document page, which can be manipulated for rendering and interaction purposes.

Implements IUILayerContainer.UILayers

ViewportRectangle

Gets the rectangle that represents the current viewport area of the document page presenter.

Declaration

cs-api-definition
public RectangleF ViewportRectangle { get; set; }

Property Value

RectangleF

Methods

ArrangeOverride(Size)

Declaration

cs-api-definition
protected override Size ArrangeOverride(Size finalSize)

Parameters

finalSize

Size

Returns

Size

FocusCaret()

Sets the focus to the caret in the document page presenter.

Declaration

cs-api-definition
public void FocusCaret()

IsLayerSupported(IUILayer)

Determines whether the specified UI layer is supported by the document page presenter.

Declaration

cs-api-definition
public bool IsLayerSupported(IUILayer layer)

Parameters

layer

IUILayer

The UI layer to check for support.

Returns

bool

True if the specified layer is supported; otherwise, false.

Implements IUILayerContainer.IsLayerSupported(IUILayer)

MeasureOverride(Size)

Declaration

cs-api-definition
protected override Size MeasureOverride(Size availableSize)

Parameters

availableSize

Size

Returns

Size

SetKeyboardSelectionHandler(KeyboardSelectionHandler)

Sets the keyboard selection handler for the document page presenter.

Declaration

cs-api-definition
public void SetKeyboardSelectionHandler(KeyboardSelectionHandler keyboardSelectionHandler)

Parameters

keyboardSelectionHandler

KeyboardSelectionHandler

The keyboard selection handler to be set, which is responsible for managing keyboard interactions for selection purposes.

SetMouseSelectionHandler(MouseSelectionHandler)

Sets the mouse selection handler for the document page presenter.

Declaration

cs-api-definition
public void SetMouseSelectionHandler(MouseSelectionHandler mouseSelectionHandler)

Parameters

mouseSelectionHandler

MouseSelectionHandler

The mouse selection handler to be set.

UpdateCaretSize()

Updates the size of the caret in the document page presenter.

Declaration

cs-api-definition
public void UpdateCaretSize()