SerializerWriter.WriteAsync Method (DocumentPaginator, PrintTicket, Object)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

When overridden in a derived class, asynchronously writes paginated content together with an associated PrintTicket to the serialization Stream.

Namespace:   System.Windows.Documents.Serialization
Assembly:  PresentationFramework (in PresentationFramework.dll)

public abstract void WriteAsync(
	DocumentPaginator documentPaginator,
	PrintTicket printTicket,
	object userState
)

Parameters

documentPaginator
Type: System.Windows.Documents.DocumentPaginator

The document paginator that defines the content to write to the serialization Stream.

printTicket
Type: System.Printing.PrintTicket

The default print preferences for the documentPaginator content.

userState
Type: System.Object

A caller-specified object to identify the asynchronous write operation.

printTicket can be null if there are no preferred print settings.

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

userState is passed to the WritingCompletedEventHandler when the WritingCompleted event occurs.

The output Stream of the write operation is normally specified as a parameter to the constructor of the derived class that implements SerializerWriter.

.NET Framework
Available since 3.0
Return to top
Show: