Class
DocumentPrintLayoutPresenter

Used in RadRichTextBox for presenting documents in "Print" LayoutMode. See also DocumentWebLayoutPresenter

Definition

Namespace:Telerik.Windows.Documents.UI

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition

public class DocumentPrintLayoutPresenter : DocumentPresenterBase, IDocumentEditorPresenter

Inheritance: objectDocumentPresenterBaseDocumentPrintLayoutPresenter

Implements: IDocumentEditorPresenter

Constructors

DocumentPrintLayoutPresenter()

Declaration

cs-api-definition

public DocumentPrintLayoutPresenter()

Properties

IsFocused

Gets a value indicating whether the document print layout presenter currently has focus.

Declaration

cs-api-definition

public override bool IsFocused { get; }

Property Value

bool

Overrides DocumentPresenterBase.IsFocused

PagePresentersMargin

Gets or sets value corresponding to the margins between child page-presenters.

Declaration

cs-api-definition

public SizeF PagePresentersMargin { get; set; }

Property Value

SizeF

ScrollableHeight

Gets the height of the scrollable area within the document print layout presenter.

Declaration

cs-api-definition

public override double ScrollableHeight { get; }

Property Value

double

Overrides DocumentPresenterBase.ScrollableHeight

ScrollableWidth

Gets the width available for scrolling in the document print layout presenter.

Declaration

cs-api-definition

public override double ScrollableWidth { get; }

Property Value

double

Overrides DocumentPresenterBase.ScrollableWidth

Methods

ArrangeOverride(Size)

Declaration

cs-api-definition

protected override Size ArrangeOverride(Size finalSize)

Parameters

finalSize

Size

Returns

Size

DoOnDocumentChanged()

Executes actions that need to take place when the document has changed.

Declaration

cs-api-definition

public override void DoOnDocumentChanged()

Overrides DocumentPresenterBase.DoOnDocumentChanged()

DoOnDocumentChanging()

Executes actions necessary when the document is changing.

Declaration

cs-api-definition

public override void DoOnDocumentChanging()

Overrides DocumentPresenterBase.DoOnDocumentChanging()

Remarks

This method is typically called to handle any updates or changes required before the document transitions to a new state.

FocusCaret()

Sets the focus to the caret in the document print layout presenter.

Declaration

cs-api-definition

public override void FocusCaret()

Overrides DocumentPresenterBase.FocusCaret()

GetCurrentPage()

Retrieves the current page number in the document print layout presenter.

Declaration

cs-api-definition

public override int GetCurrentPage()

Returns

int

The current page number as an integer.

Overrides DocumentPresenterBase.GetCurrentPage()

GetCurrentSectionBoundsInViewOverride()

This method supports control infrastructure and is not intended for use directly from your code.

Declaration

cs-api-definition

protected override Rect GetCurrentSectionBoundsInViewOverride()

Returns

Rect

Overrides DocumentPresenterBase.GetCurrentSectionBoundsInViewOverride()

GetDocumentPointFromViewPoint(Point)

Converts a specified view point in the user interface to a corresponding document point for printing purposes.

Declaration

cs-api-definition

public override Point GetDocumentPointFromViewPoint(Point viewPoint)

Parameters

viewPoint

Point

The point in the UI that needs to be converted to a document point.

Returns

Point

Returns a Point representing the corresponding document point.

Overrides DocumentPresenterBase.GetDocumentPointFromViewPoint(Point)

GetDocumentPositionFromViewPoint(Point)

Retrieves the document position corresponding to a specified view point.

Declaration

cs-api-definition

public override DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)

Parameters

viewPoint

Point

The point in the view from which to calculate the document position.

Returns

DocumentPosition

A DocumentPosition representing the document position at the specified view point.

Overrides DocumentPresenterBase.GetDocumentPositionFromViewPoint(Point)

GetDropPositionMarker()

Declaration

cs-api-definition

protected override DropPositionMarker GetDropPositionMarker()

Returns

DropPositionMarker

Overrides DocumentPresenterBase.GetDropPositionMarker()

GetViewPointFromDocumentPosition(DocumentPosition)

Retrieves the viewpoint corresponding to the specified document position in the print layout presenter.

Declaration

cs-api-definition

public override Point GetViewPointFromDocumentPosition(DocumentPosition position)

Parameters

position

DocumentPosition

The document position for which the viewpoint is to be retrieved.

Returns

Point

The viewpoint associated with the given document position.

Overrides DocumentPresenterBase.GetViewPointFromDocumentPosition(DocumentPosition)

HandlePageDown()

Handles the Page Down command in the Document Print Layout Presenter. This method facilitates navigation through the document by scrolling down one page at a time when the Page Down key is pressed.

Declaration

cs-api-definition

public override void HandlePageDown()

Overrides DocumentPresenterBase.HandlePageDown()

HandlePageUp()

Handles the Page Up key press event to navigate to the previous page in the document layout.

Declaration

cs-api-definition

public override void HandlePageUp()

Overrides DocumentPresenterBase.HandlePageUp()

HideCaret()

Hides the caret in the document print layout presenter.

Declaration

cs-api-definition

public override void HideCaret()

Overrides DocumentPresenterBase.HideCaret()

InvalidatePresenterArrangeOverride()

Declaration

cs-api-definition

protected override void InvalidatePresenterArrangeOverride()

Overrides DocumentPresenterBase.InvalidatePresenterArrangeOverride()

InvalidatePresenterMeasureOverride()

Declaration

cs-api-definition

protected override void InvalidatePresenterMeasureOverride()

Overrides DocumentPresenterBase.InvalidatePresenterMeasureOverride()

MeasureOverride(Size)

Declaration

cs-api-definition

protected override Size MeasureOverride(Size availableSize)

Parameters

availableSize

Size

Returns

Size

OnApplyTemplate()

Executes the logic required when a template is applied to the DocumentPrintLayoutPresenter.

Declaration

cs-api-definition

public override void OnApplyTemplate()

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition

protected override void OnInitialized(EventArgs e)

Parameters

EventArgs

The RoutedEventArgs that contains the event data.

OnOwnerChanging()

Declaration

cs-api-definition

protected override void OnOwnerChanging()

Overrides DocumentPresenterBase.OnOwnerChanging()

RecreateUI()

Recreates the user interface for the document print layout presenter.

Declaration

cs-api-definition

public override void RecreateUI()

Overrides DocumentPresenterBase.RecreateUI()

Remarks

This method refreshes and rebuilds the visual representation of the document in the print layout mode, ensuring that all changes to the document are accurately reflected in the UI.

ScrollToNote(Note)

Scrolls the document view to the specified note.

Declaration

cs-api-definition

public override void ScrollToNote(Note note)

Parameters

note

Note

Overrides DocumentPresenterBase.ScrollToNote(Note)

SetCaretBlinking(bool)

Declaration

cs-api-definition

protected override void SetCaretBlinking(bool isBlinking)

Parameters

isBlinking

bool

Overrides DocumentPresenterBase.SetCaretBlinking(bool)

ShowCaret()

Displays the caret in the document print layout presenter.

Declaration

cs-api-definition

public override void ShowCaret()

Overrides DocumentPresenterBase.ShowCaret()

UpdateCaretProperties()

Updates the properties of the caret in the document print layout presenter.

Declaration

cs-api-definition

public override void UpdateCaretProperties()

Overrides DocumentPresenterBase.UpdateCaretProperties()

UpdateCaretSize()

Updates the size of the caret in the document print layout presenter.

Declaration

cs-api-definition

public override void UpdateCaretSize()

Overrides DocumentPresenterBase.UpdateCaretSize()

UpdateProofingTextDecoration()

Updates the text decoration for proofing in the document print layout presenter.

Declaration

cs-api-definition

public override void UpdateProofingTextDecoration()

Overrides DocumentPresenterBase.UpdateProofingTextDecoration()

UpdateScrollOffsetFromDocumentPosition(DocumentPosition)

Updates the scroll offset based on the specified document position.

Declaration

cs-api-definition

public override void UpdateScrollOffsetFromDocumentPosition(DocumentPosition documentPosition)

Parameters

documentPosition

DocumentPosition

The document position used to update the scroll offset.

Overrides DocumentPresenterBase.UpdateScrollOffsetFromDocumentPosition(DocumentPosition)

ClassDocumentPrintLayoutPresenter

Class
DocumentPrintLayoutPresenter