New to Telerik UI for WPFStart a free 30-day trial

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:

C#
public class DocumentPrintLayoutPresenter : DocumentPresenterBase, IDocumentEditorPresenter

Inheritance: objectDocumentPresenterBaseDocumentPrintLayoutPresenter

Implements: IDocumentEditorPresenter

Inherited Members DocumentPresenterBase.DragMarginDocumentPresenterBase.OnPreviewKeyDown(KeyEventArgs)DocumentPresenterBase.OnKeyUp(KeyEventArgs)DocumentPresenterBase.ScrollToHorizontalOffset(double)DocumentPresenterBase.ScrollToVerticalOffset(double)DocumentPresenterBase.InvalidatePresenterArrange()DocumentPresenterBase.InvalidatePresenterMeasure()DocumentPresenterBase.OnOwnerChanged()DocumentPresenterBase.OnGotFocus(RoutedEventArgs)DocumentPresenterBase.OnLostFocus(RoutedEventArgs)DocumentPresenterBase.ShowDropMarker(DocumentPosition)DocumentPresenterBase.MoveDropMarker(DocumentPosition)DocumentPresenterBase.HideDropMarker()DocumentPresenterBase.GetValidScaleFactor(double, double)DocumentPresenterBase.IsNavigationKey(Key)DocumentPresenterBase.InvalidateLayout()DocumentPresenterBase.InvalidateAndUpdateLayout()DocumentPresenterBase.UpdateScrollBar(double, double, ScrollBar, ScrollBarVisibility)DocumentPresenterBase.UpdateCurrentVisiblePage(int)DocumentPresenterBase.HorizontalOffsetDocumentPresenterBase.VerticalOffsetDocumentPresenterBase.ViewportHeightDocumentPresenterBase.ViewportWidthDocumentPresenterBase.VerticalScrollOffsetDocumentPresenterBase.HorizontalScrollOffsetDocumentPresenterBase.ScaleFactorDocumentPresenterBase.MouseSelectionHandlerDocumentPresenterBase.KeyboardSelectionHandlerDocumentPresenterBase.CaretPositionDocumentPresenterBase.Owner...

Constructors

C#
public DocumentPrintLayoutPresenter()

Properties

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

C#
public override bool IsFocused { get; }

Overrides: DocumentPresenterBase.IsFocused

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

C#
public SizeF PagePresentersMargin { get; set; }

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

C#
public override double ScrollableHeight { get; }

Overrides: DocumentPresenterBase.ScrollableHeight

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

C#
public override double ScrollableWidth { get; }

Overrides: DocumentPresenterBase.ScrollableWidth

Methods

C#
protected override Size ArrangeOverride(Size finalSize)
Parameters:finalSizeSizeReturns:

Size

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

C#
public override void DoOnDocumentChanged()

Overrides: DocumentPresenterBase.DoOnDocumentChanged()

Executes actions necessary when the document is changing.

C#
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.

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

C#
public override void FocusCaret()

Overrides: DocumentPresenterBase.FocusCaret()

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

C#
public override int GetCurrentPage()
Returns:

int

The current page number as an integer.

Overrides: DocumentPresenterBase.GetCurrentPage()

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

C#
protected override Rect GetCurrentSectionBoundsInViewOverride()
Returns:

Rect

Overrides: DocumentPresenterBase.GetCurrentSectionBoundsInViewOverride()

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

C#
public override Point GetDocumentPointFromViewPoint(Point viewPoint)
Parameters:viewPointPoint

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)

Retrieves the document position corresponding to a specified view point.

C#
public override DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)
Parameters:viewPointPoint

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)

C#
protected override DropPositionMarker GetDropPositionMarker()
Returns:

DropPositionMarker

Overrides: DocumentPresenterBase.GetDropPositionMarker()

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

C#
public override Point GetViewPointFromDocumentPosition(DocumentPosition position)
Parameters:positionDocumentPosition

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)

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.

C#
public override void HandlePageDown()

Overrides: DocumentPresenterBase.HandlePageDown()

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

C#
public override void HandlePageUp()

Overrides: DocumentPresenterBase.HandlePageUp()

Hides the caret in the document print layout presenter.

C#
public override void HideCaret()

Overrides: DocumentPresenterBase.HideCaret()

C#
protected override void InvalidatePresenterArrangeOverride()

Overrides: DocumentPresenterBase.InvalidatePresenterArrangeOverride()

C#
protected override void InvalidatePresenterMeasureOverride()

Overrides: DocumentPresenterBase.InvalidatePresenterMeasureOverride()

C#
protected override Size MeasureOverride(Size availableSize)
Parameters:availableSizeSizeReturns:

Size

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

C#
public override void OnApplyTemplate()

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

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

C#
protected override void OnOwnerChanging()

Overrides: DocumentPresenterBase.OnOwnerChanging()

Recreates the user interface for the document print layout presenter.

C#
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.

Scrolls the document view to the specified note.

C#
public override void ScrollToNote(Note note)
Parameters:noteNote

Overrides: DocumentPresenterBase.ScrollToNote(Note)

C#
protected override void SetCaretBlinking(bool isBlinking)
Parameters:isBlinkingbool

Overrides: DocumentPresenterBase.SetCaretBlinking(bool)

Displays the caret in the document print layout presenter.

C#
public override void ShowCaret()

Overrides: DocumentPresenterBase.ShowCaret()

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

C#
public override void UpdateCaretProperties()

Overrides: DocumentPresenterBase.UpdateCaretProperties()

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

C#
public override void UpdateCaretSize()

Overrides: DocumentPresenterBase.UpdateCaretSize()

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

C#
public override void UpdateProofingTextDecoration()

Overrides: DocumentPresenterBase.UpdateProofingTextDecoration()

Updates the scroll offset based on the specified document position.

C#
public override void UpdateScrollOffsetFromDocumentPosition(DocumentPosition documentPosition)
Parameters:documentPositionDocumentPosition

The document position used to update the scroll offset.

Overrides: DocumentPresenterBase.UpdateScrollOffsetFromDocumentPosition(DocumentPosition)