Class
DocumentPrintPresenter

Represents a presenter for printing documents in the Telerik UI framework.

Definition

Namespace:Telerik.Windows.Documents.UI

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class DocumentPrintPresenter : ContentControl, IDocumentEditorPresenter, IUILayerContainer

Inheritance: objectDocumentPrintPresenter

Implements: IDocumentEditorPresenterIUILayerContainer

Constructors

DocumentPrintPresenter(PrintSettings)

Declaration

cs-api-definition
public DocumentPrintPresenter(PrintSettings settings)

Parameters

settings

PrintSettings

Properties

IsFocusable

Gets a value indicating whether the document print presenter can receive focus.

Declaration

cs-api-definition
public bool IsFocusable { get; set; }

Property Value

bool

IsPrinting

Gets a value indicating whether the document is currently being printed.

Declaration

cs-api-definition
public bool IsPrinting { get; set; }

Property Value

bool

Owner

Gets or sets the owner of the DocumentPrintPresenter.

Declaration

cs-api-definition
public RadRichTextBox Owner { get; set; }

Property Value

RadRichTextBox

The owner of the DocumentPrintPresenter.

Implements IDocumentEditorPresenter.Owner

Settings

Represents the settings for the document print presenter.

Declaration

cs-api-definition
public PrintSettings Settings { get; set; }

Property Value

PrintSettings

UILayers

Represents the collection of UI layers in the DocumentPrintPresenter.

Declaration

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

Property Value

UILayerStack

Implements IUILayerContainer.UILayers

Methods

ArrangeOverride(Size)

Declaration

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

Parameters

finalSize

Size

Returns

Size

DoOnDocumentChanged()

Executes necessary actions when the document changes.

Declaration

cs-api-definition
public void DoOnDocumentChanged()

Implements IDocumentEditorPresenter.DoOnDocumentChanged()

DoOnDocumentChanging()

Executes actions that need to occur when the document is about to change.

Declaration

cs-api-definition
public void DoOnDocumentChanging()

Implements IDocumentEditorPresenter.DoOnDocumentChanging()

FocusCaret()

Sets the focus to the caret in the document print presenter, allowing for user interaction with the print content.

Declaration

cs-api-definition
public void FocusCaret()

Implements IDocumentEditorPresenter.FocusCaret()

GetDocumentPointFromViewPoint(Point)

Converts a specified point in the view coordinates to the corresponding point in the document coordinates.

Declaration

cs-api-definition
public Point GetDocumentPointFromViewPoint(Point viewPoint)

Parameters

viewPoint

Point

The point in view coordinates that needs to be converted.

Returns

Point

A point in document coordinates that corresponds to the specified view point.

Implements IDocumentEditorPresenter.GetDocumentPointFromViewPoint(Point)

GetDocumentPositionFromViewPoint(Point)

Retrieves the document position corresponding to a specified view point.

Declaration

cs-api-definition
public DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)

Parameters

viewPoint

Point

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

Returns

DocumentPosition

The position within the document that corresponds to the given view point.

Implements IDocumentEditorPresenter.GetDocumentPositionFromViewPoint(Point)

GetViewPointFromDocumentPosition(DocumentPosition)

Retrieves the viewpoint corresponding to a specified document position.

Declaration

cs-api-definition
public Point GetViewPointFromDocumentPosition(DocumentPosition position)

Parameters

position

DocumentPosition

The document position from which to obtain the viewpoint.

Returns

Point

The viewpoint that represents the specified document position.

Implements IDocumentEditorPresenter.GetViewPointFromDocumentPosition(DocumentPosition)

HideCaret()

Hides the caret in the document print presenter.

Declaration

cs-api-definition
public void HideCaret()

Implements IDocumentEditorPresenter.HideCaret()

HideDropMarker()

Hides the drop marker displayed in the document print presenter.

Declaration

cs-api-definition
public void HideDropMarker()

Implements IDocumentEditorPresenter.HideDropMarker()

IsLayerSupported(IUILayer)

Determines whether a specified UI layer is supported by the Document Print Presenter.

Declaration

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

Parameters

layer

IUILayer

The UI layer to evaluate 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

MoveDropMarker(DocumentPosition)

Moves the drop marker to the specified document position.

Declaration

cs-api-definition
public void MoveDropMarker(DocumentPosition position)

Parameters

position

DocumentPosition

The document position at which to move the drop marker.

Implements IDocumentEditorPresenter.MoveDropMarker(DocumentPosition)

Print(PrintDialog, PrintSettings)

Prints the document using the specified print dialog and print settings.

Declaration

cs-api-definition
public void Print(PrintDialog printDialog, PrintSettings settings)

Parameters

printDialog

PrintDialog

The print dialog used to configure print options.

settings

PrintSettings

The settings that define how the document should be printed.

RecreateUI()

Recreates the user interface for the document print presenter. This method is typically called to refresh the UI elements when the underlying document or settings change.

Declaration

cs-api-definition
public void RecreateUI()

Implements IDocumentEditorPresenter.RecreateUI()

ShowCaret()

Displays the caret in the document viewer.

Declaration

cs-api-definition
public void ShowCaret()

Implements IDocumentEditorPresenter.ShowCaret()

ShowDropMarker(DocumentPosition)

Displays a drop marker at the specified document position in the print presenter.

Declaration

cs-api-definition
public void ShowDropMarker(DocumentPosition position)

Parameters

position

DocumentPosition

The document position where the drop marker will be displayed.

Implements IDocumentEditorPresenter.ShowDropMarker(DocumentPosition)

UpdateCaretProperties()

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

Declaration

cs-api-definition
public void UpdateCaretProperties()

Implements IDocumentEditorPresenter.UpdateCaretProperties()

UpdateCaretSize()

Updates the size of the caret for the document print presenter.

Declaration

cs-api-definition
public void UpdateCaretSize()

Implements IDocumentEditorPresenter.UpdateCaretSize()

UpdateProofingTextDecoration()

Updates the text decoration for proofing within the document print presenter.

Declaration

cs-api-definition
public void UpdateProofingTextDecoration()

Implements IDocumentEditorPresenter.UpdateProofingTextDecoration()

Events

PrintingCompleted

Declaration

cs-api-definition
public event EventHandler<PrintCompletedEventArgs> PrintingCompleted

Event Value

EventHandler<PrintCompletedEventArgs>

PrintingStarted

Declaration

cs-api-definition
public event EventHandler PrintingStarted

Event Value

EventHandler