XpsDocumentWriter.WriteAsync Method (FixedDocumentSequence, PrintTicket, Object)

 

Writes asynchronously a specified FixedDocumentSequence together with a PrintTicket to the target XpsDocument or PrintQueue.

Namespace:   System.Windows.Xps
Assembly:  System.Printing (in System.Printing.dll)

public override void WriteAsync(
	FixedDocumentSequence fixedDocumentSequence,
	PrintTicket printTicket,
	object userSuppliedState
)

Parameters

fixedDocumentSequence
Type: System.Windows.Documents.FixedDocumentSequence

The set of documents to be written.

printTicket
Type: System.Printing.PrintTicket

A PrintTicket that represents the default printing preferences for the set of documents.

userSuppliedState
Type: System.Object

A user-specified object to identify and associate with the asynchronous operation.

WriteAsync writes a set of documents asynchronously to the XpsDocument or PrintQueue that created the XpsDocumentWriter. The data that is written includes a PrintTicket and additional information that the caller wants to pass to an event handler.

Although the XpsDocument class has a singular name, an XpsDocument can be one FixedDocument or a set of multiple documents. This method adds a FixedDocument or a set of FixedDocument elements to the existing sequence.

This method does not validate or modify the specified printTicket for a particular PrintQueue. If necessary, use the MergeAndValidatePrintTicket method to create a PrintTicket that is specific to the PrintQueue and is valid for a specified printer.

.NET Framework
Available since 3.0
Return to top
Show: