PrintDocument Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines a reusable object that sends output to a printer.
/// [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)]
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)]
public class PrintDocument : DependencyObjectPublic Class PrintDocument
Inherits DependencyObject- Inheritance
- Attributes
Windows 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. |
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. (Inherited from DependencyObject) |
| DocumentSource |
Gets a document source reference for this PrintDocument. |
| DocumentSourceProperty |
Identifies the DocumentSource dependency property. |
Methods
| AddPage(UIElement) |
Adds a XAML root visual element to the print list. |
| AddPagesComplete() |
Indicates that the application will not add more pages to the print list, and that the print list is ready to be released. |
| ClearValue(DependencyProperty) |
Clears the local value of a dependency property. (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. (Inherited from DependencyObject) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| InvalidatePreview() |
References the low-level print preview dialog API and invalidates the current print preview. |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback) |
Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject) |
| SetPreviewPage(Int32, UIElement) |
Sets the specified print page as the current print preview page. |
| SetPreviewPageCount(Int32, PreviewPageCountType) |
Sets the number of pages prepared for print preview and added to the print list. |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
| UnregisterPropertyChangedCallback(DependencyProperty, Int64) |
Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject) |
Events
| AddPages |
Occurs when the PrintManager requests the final collection of pages to send to the printer. |
| GetPreviewPage |
Occurs when the PrintManager requests a particular print page to be shown in the preview window. |
| Paginate |
Occurs when the PrintManager requests the collection of print pages to be shown in the preview window. |