Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

PrintQueue::CreateXpsDocumentWriter Method (String, PrintDocumentImageableArea%)

Creates an XpsDocumentWriter object, opens a Windows common print dialog (and provides it a job description) and returns a ref (ByRef in Visual Basic) parameter that represents information about the imageable area and the dimensions of the media.

Namespace:  System.Printing
Assembly:  System.Printing (in System.Printing.dll)
public:
static XpsDocumentWriter^ CreateXpsDocumentWriter(
	String^ jobDescription, 
	PrintDocumentImageableArea^% documentImageableArea
)

Parameters

jobDescription
Type: System::String

A name for the print job. It appears in the Windows printing user interface.

documentImageableArea
Type: System.Printing::PrintDocumentImageableArea%

A reference to an object that contains the dimensions of the area of the page on which the device can print. Since its data type has no public constructor, this parameter is passed uninitialized.

Return Value

Type: System.Windows.Xps::XpsDocumentWriter
An XpsDocumentWriter that writes XPS data to a stream. This can be nullptr. (The parameter documentImageableArea is a ref [ByRef in Visual Basic] parameter that is initialized by the method, so it represents a second returned item.)

Many printers need up to a quarter of an inch of unprinted space around the edges of each page to grip the paper and move it through the printer. Otherwise toner would foul the paper flow mechanism. The area which can be printed is the "imageable area."

The type PrintDocumentImageableArea has no public constructor. Hence, the variable documentImageableArea must be declared and assigned to nullptr and only then passed to the method. This method displays a PrintDialog requiring input from the user. After the user has selected a printer, paper size, and orientation and closed the dialog, documentImageableArea points to an actual object, and its properties are initialized.

If the user cancels or closes the dialog, the return value is nullptr. As a consequence, the return value must be checked for nullptr by your application.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.