PrintDocument Class

Definition

Namespace:: Windows.UI.Xaml.Printing

Edit

Defines a reusable object that sends output to a printer.

Equivalent WinUI class: Microsoft.UI.Xaml.Printing.PrintDocument.

/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Printing.IPrintDocumentFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Printing.IPrintDocumentStatics, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class PrintDocument : DependencyObject

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Printing.IPrintDocumentFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Printing.IPrintDocumentStatics, 65536, "Windows.Foundation.UniversalApiContract")]
class PrintDocument : DependencyObject

[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Printing.IPrintDocumentFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Printing.IPrintDocumentStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class PrintDocument : DependencyObject

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Printing.IPrintDocumentFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Printing.IPrintDocumentStatics), 65536, "Windows.Foundation.UniversalApiContract")]
public class PrintDocument : DependencyObject

Public Class PrintDocument
Inherits DependencyObject

Inheritance: Object

DependencyObject
PrintDocument

Attributes: ComposableAttribute ContractVersionAttribute MarshalingBehaviorAttribute StaticAttribute ThreadingAttribute WebHostHiddenAttribute

Windows 10 requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

PrintDocument implements a print list concept whereby pages can be added to the print list, and then various methods can be called on the ongoing print list.

Constructors

PrintDocument()

Initializes a new instance of the PrintDocument class.

Equivalent WinUI constructor: Microsoft.UI.Xaml.Printing.PrintDocument.PrintDocument.

Properties

Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher.

(Inherited from DependencyObject)

DocumentSource

Gets a document source reference for this PrintDocument.

Equivalent WinUI property: Microsoft.UI.Xaml.Printing.PrintDocument.DocumentSource.

DocumentSourceProperty

Identifies the DocumentSource dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Printing.PrintDocument.DocumentSourceProperty.

Methods

AddPage(UIElement)	Adds a XAML root visual element to the print list. Equivalent WinUI method: Microsoft.UI.Xaml.Printing.PrintDocument.AddPage.
AddPagesComplete()	Indicates that the application will not add more pages to the print list, and that the print list is ready to be released. Equivalent WinUI method: Microsoft.UI.Xaml.Printing.PrintDocument.AddPagesComplete.
ClearValue(DependencyProperty)	Clears the local value of a dependency property. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue. (Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue. (Inherited from DependencyObject)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue. (Inherited from DependencyObject)
InvalidatePreview()	References the low-level print preview dialog API and invalidates the current print preview. Equivalent WinUI method: Microsoft.UI.Xaml.Printing.PrintDocument.InvalidatePreview.
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback. (Inherited from DependencyObject)
SetPreviewPage(Int32, UIElement)	Sets the specified print page as the current print preview page. Equivalent WinUI method: Microsoft.UI.Xaml.Printing.PrintDocument.SetPreviewPage.
SetPreviewPageCount(Int32, PreviewPageCountType)	Sets the number of pages prepared for print preview and added to the print list. Equivalent WinUI method: Microsoft.UI.Xaml.Printing.PrintDocument.SetPreviewPageCount.
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback. (Inherited from DependencyObject)

Events

AddPages

Occurs when the PrintManager requests the final collection of pages to send to the printer.

Equivalent WinUI event: Microsoft.UI.Xaml.Printing.PrintDocument.AddPages.

GetPreviewPage

Occurs when the PrintManager requests a particular print page to be shown in the preview window.

Equivalent WinUI event: Microsoft.UI.Xaml.Printing.PrintDocument.GetPreviewPage.

Paginate

Occurs when the PrintManager requests the collection of print pages to be shown in the preview window.

Equivalent WinUI event: Microsoft.UI.Xaml.Printing.PrintDocument.Paginate.

Applies to