SerializerWriter.WriteAsync Method

Definition

Namespace:

System.Windows.Documents.Serialization

Assembly:

PresentationFramework.dll

When overridden in a derived class, asynchronously writes content to the serialization Stream.

Overloads

WriteAsync(FixedPage, Object)	When overridden in a derived class, asynchronously writes a given FixedPage to the serialization Stream.
WriteAsync(Visual, PrintTicket, Object)	When overridden in a derived class, asynchronously writes a given Visual element together with an associated PrintTicket and identifier to the serialization Stream.
WriteAsync(FixedPage, PrintTicket, Object)	When overridden in a derived class, asynchronously writes a given FixedPage together with an associated PrintTicket to the serialization Stream.
WriteAsync(FixedDocumentSequence, PrintTicket, Object)	When overridden in a derived class, asynchronously writes a given FixedDocumentSequence together with an associated PrintTicket to the serialization Stream.
WriteAsync(FixedDocument, PrintTicket, Object)	When overridden in a derived class, asynchronously writes a given FixedDocument together with an associated PrintTicket to the serialization Stream.
WriteAsync(DocumentPaginator, PrintTicket, Object)	When overridden in a derived class, asynchronously writes paginated content together with an associated PrintTicket to the serialization Stream.
WriteAsync(Visual, PrintTicket)	When overridden in a derived class, asynchronously writes a given Visual element together with an associated PrintTicket to the serialization Stream.
WriteAsync(Visual, Object)	When overridden in a derived class, asynchronously writes a given Visual element to the serialization Stream.
WriteAsync(FixedPage, PrintTicket)	When overridden in a derived class, asynchronously writes a given FixedPage together with an associated PrintTicket to the serialization Stream.
WriteAsync(FixedDocumentSequence, PrintTicket)	When overridden in a derived class, asynchronously writes a given FixedDocumentSequence together with an associated PrintTicket to the serialization Stream.
WriteAsync(Visual)	When overridden in a derived class, asynchronously writes a given Visual element to the serialization Stream.
WriteAsync(FixedDocument, PrintTicket)	When overridden in a derived class, asynchronously writes a given FixedDocument together with an associated PrintTicket to the serialization Stream.
WriteAsync(FixedDocument, Object)	When overridden in a derived class, asynchronously writes a given FixedDocument to the serialization Stream.
WriteAsync(DocumentPaginator, PrintTicket)	When overridden in a derived class, asynchronously writes the content of a given DocumentPaginator to the serialization Stream.
WriteAsync(DocumentPaginator, Object)	When overridden in a derived class, asynchronously writes the content of a given DocumentPaginator to the serialization Stream.
WriteAsync(FixedPage)	When overridden in a derived class, asynchronously writes a given FixedPage to the serialization Stream.
WriteAsync(FixedDocumentSequence)	When overridden in a derived class, asynchronously writes a given FixedDocumentSequence to the serialization Stream.
WriteAsync(FixedDocument)	When overridden in a derived class, asynchronously writes a given FixedDocument to the serialization Stream.
WriteAsync(DocumentPaginator)	When overridden in a derived class, asynchronously writes the content of a given DocumentPaginator to the serialization Stream.
WriteAsync(FixedDocumentSequence, Object)	When overridden in a derived class, asynchronously writes a given FixedDocumentSequence to the serialization Stream.

Remarks

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

WriteAsync(FixedPage, Object)

When overridden in a derived class, asynchronously writes a given FixedPage to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Documents::FixedPage ^ fixedPage, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Documents.FixedPage fixedPage, object userState);

abstract member WriteAsync : System.Windows.Documents.FixedPage * obj -> unit

Public MustOverride Sub WriteAsync (fixedPage As FixedPage, userState As Object)

Parameters

fixedPage

FixedPage

The page to write to the serialization Stream.

userState

Object

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

Remarks

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.

See also

• Write(FixedPage)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(Visual, PrintTicket, Object)

When overridden in a derived class, asynchronously writes a given Visual element together with an associated PrintTicket and identifier to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Media::Visual ^ visual, System::Printing::PrintTicket ^ printTicket, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Media.Visual visual, System.Printing.PrintTicket printTicket, object userState);

abstract member WriteAsync : System.Windows.Media.Visual * System.Printing.PrintTicket * obj -> unit

Public MustOverride Sub WriteAsync (visual As Visual, printTicket As PrintTicket, userState As Object)

Parameters

visual

Visual

The Visual element to write to the serialization Stream.

printTicket

PrintTicket

The default print preferences for the visual element.

userState

Object

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

Remarks

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.

See also

• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedPage, PrintTicket, Object)

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

public:
 abstract void WriteAsync(System::Windows::Documents::FixedPage ^ fixedPage, System::Printing::PrintTicket ^ printTicket, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Documents.FixedPage fixedPage, System.Printing.PrintTicket printTicket, object userState);

abstract member WriteAsync : System.Windows.Documents.FixedPage * System.Printing.PrintTicket * obj -> unit

Public MustOverride Sub WriteAsync (fixedPage As FixedPage, printTicket As PrintTicket, userState As Object)

Parameters

fixedPage

FixedPage

The page to write to the serialization Stream.

printTicket

PrintTicket

The default print preferences for the fixedPage content.

userState

Object

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

Remarks

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.

See also

• Write(FixedPage, PrintTicket)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedDocumentSequence, PrintTicket, Object)

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

public:
 abstract void WriteAsync(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence, System::Printing::PrintTicket ^ printTicket, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence, System.Printing.PrintTicket printTicket, object userState);

abstract member WriteAsync : System.Windows.Documents.FixedDocumentSequence * System.Printing.PrintTicket * obj -> unit

Public MustOverride Sub WriteAsync (fixedDocumentSequence As FixedDocumentSequence, printTicket As PrintTicket, userState As Object)

Parameters

fixedDocumentSequence

FixedDocumentSequence

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

printTicket

PrintTicket

The default print preferences for the fixedDocumentSequence content.

userState

Object

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

Remarks

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.

See also

• Write(FixedDocument, PrintTicket)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedDocument, PrintTicket, Object)

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

public:
 abstract void WriteAsync(System::Windows::Documents::FixedDocument ^ fixedDocument, System::Printing::PrintTicket ^ printTicket, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Documents.FixedDocument fixedDocument, System.Printing.PrintTicket printTicket, object userState);

abstract member WriteAsync : System.Windows.Documents.FixedDocument * System.Printing.PrintTicket * obj -> unit

Public MustOverride Sub WriteAsync (fixedDocument As FixedDocument, printTicket As PrintTicket, userState As Object)

Parameters

fixedDocument

FixedDocument

The document to write to the serialization Stream.

printTicket

PrintTicket

The default print preferences for the fixedDocument content.

userState

Object

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

Remarks

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.

See also

• Write(DocumentPaginator, PrintTicket)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(DocumentPaginator, PrintTicket, Object)

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

public:
 abstract void WriteAsync(System::Windows::Documents::DocumentPaginator ^ documentPaginator, System::Printing::PrintTicket ^ printTicket, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Documents.DocumentPaginator documentPaginator, System.Printing.PrintTicket printTicket, object userState);

abstract member WriteAsync : System.Windows.Documents.DocumentPaginator * System.Printing.PrintTicket * obj -> unit

Public MustOverride Sub WriteAsync (documentPaginator As DocumentPaginator, printTicket As PrintTicket, userState As Object)

Parameters

documentPaginator

DocumentPaginator

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

printTicket

PrintTicket

The default print preferences for the documentPaginator content.

userState

Object

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

Remarks

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.

See also

• Write(DocumentPaginator, PrintTicket)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(Visual, PrintTicket)

When overridden in a derived class, asynchronously writes a given Visual element together with an associated PrintTicket to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Media::Visual ^ visual, System::Printing::PrintTicket ^ printTicket);

public abstract void WriteAsync (System.Windows.Media.Visual visual, System.Printing.PrintTicket printTicket);

abstract member WriteAsync : System.Windows.Media.Visual * System.Printing.PrintTicket -> unit

Public MustOverride Sub WriteAsync (visual As Visual, printTicket As PrintTicket)

Parameters

visual

Visual

The Visual element to write to the serialization Stream.

printTicket

PrintTicket

The default print preferences for the visual element.

Remarks

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.

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(Visual, PrintTicket).

See also

• Write(Visual, PrintTicket)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(Visual, Object)

When overridden in a derived class, asynchronously writes a given Visual element to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Media::Visual ^ visual, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Media.Visual visual, object userState);

abstract member WriteAsync : System.Windows.Media.Visual * obj -> unit

Public MustOverride Sub WriteAsync (visual As Visual, userState As Object)

Parameters

visual

Visual

The Visual element to write to the serialization Stream.

userState

Object

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

Remarks

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.

See also

• Write(Visual)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedPage, PrintTicket)

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

public:
 abstract void WriteAsync(System::Windows::Documents::FixedPage ^ fixedPage, System::Printing::PrintTicket ^ printTicket);

public abstract void WriteAsync (System.Windows.Documents.FixedPage fixedPage, System.Printing.PrintTicket printTicket);

abstract member WriteAsync : System.Windows.Documents.FixedPage * System.Printing.PrintTicket -> unit

Public MustOverride Sub WriteAsync (fixedPage As FixedPage, printTicket As PrintTicket)

Parameters

fixedPage

FixedPage

The page to write to the serialization Stream.

printTicket

PrintTicket

The default print preferences for the fixedPage content.

Remarks

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.

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(FixedPage, PrintTicket).

See also

• Write(FixedPage, PrintTicket)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedDocumentSequence, PrintTicket)

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

public:
 abstract void WriteAsync(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence, System::Printing::PrintTicket ^ printTicket);

public abstract void WriteAsync (System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence, System.Printing.PrintTicket printTicket);

abstract member WriteAsync : System.Windows.Documents.FixedDocumentSequence * System.Printing.PrintTicket -> unit

Public MustOverride Sub WriteAsync (fixedDocumentSequence As FixedDocumentSequence, printTicket As PrintTicket)

Parameters

fixedDocumentSequence

FixedDocumentSequence

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

printTicket

PrintTicket

The default print preferences for the fixedDocumentSequence content.

Remarks

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.

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(FixedDocumentSequence, PrintTicket).

See also

• Write(FixedDocumentSequence, PrintTicket)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(Visual)

When overridden in a derived class, asynchronously writes a given Visual element to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Media::Visual ^ visual);

public abstract void WriteAsync (System.Windows.Media.Visual visual);

abstract member WriteAsync : System.Windows.Media.Visual -> unit

Public MustOverride Sub WriteAsync (visual As Visual)

Parameters

visual

Visual

The Visual element to write to the serialization Stream.

Remarks

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(Visual).

See also

• Write(Visual)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedDocument, PrintTicket)

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

public:
 abstract void WriteAsync(System::Windows::Documents::FixedDocument ^ fixedDocument, System::Printing::PrintTicket ^ printTicket);

public abstract void WriteAsync (System.Windows.Documents.FixedDocument fixedDocument, System.Printing.PrintTicket printTicket);

abstract member WriteAsync : System.Windows.Documents.FixedDocument * System.Printing.PrintTicket -> unit

Public MustOverride Sub WriteAsync (fixedDocument As FixedDocument, printTicket As PrintTicket)

Parameters

fixedDocument

FixedDocument

The document to write to the serialization Stream.

printTicket

PrintTicket

The default print preferences for the fixedDocument content.

Remarks

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.

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(FixedDocument, PrintTicket).

See also

• Write(FixedDocument, PrintTicket)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedDocument, Object)

When overridden in a derived class, asynchronously writes a given FixedDocument to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Documents::FixedDocument ^ fixedDocument, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Documents.FixedDocument fixedDocument, object userState);

abstract member WriteAsync : System.Windows.Documents.FixedDocument * obj -> unit

Public MustOverride Sub WriteAsync (fixedDocument As FixedDocument, userState As Object)

Parameters

fixedDocument

FixedDocument

The document to write to the serialization Stream.

userState

Object

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

Remarks

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.

See also

• Write(FixedDocument)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(DocumentPaginator, PrintTicket)

When overridden in a derived class, asynchronously writes the content of a given DocumentPaginator to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Documents::DocumentPaginator ^ documentPaginator, System::Printing::PrintTicket ^ printTicket);

public abstract void WriteAsync (System.Windows.Documents.DocumentPaginator documentPaginator, System.Printing.PrintTicket printTicket);

abstract member WriteAsync : System.Windows.Documents.DocumentPaginator * System.Printing.PrintTicket -> unit

Public MustOverride Sub WriteAsync (documentPaginator As DocumentPaginator, printTicket As PrintTicket)

Parameters

documentPaginator

DocumentPaginator

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

printTicket

PrintTicket

The default print preferences for the documentPaginator content.

Remarks

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.

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(DocumentPaginator, PrintTicket).

See also

• Write(DocumentPaginator, PrintTicket)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(DocumentPaginator, Object)

When overridden in a derived class, asynchronously writes the content of a given DocumentPaginator to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Documents::DocumentPaginator ^ documentPaginator, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Documents.DocumentPaginator documentPaginator, object userState);

abstract member WriteAsync : System.Windows.Documents.DocumentPaginator * obj -> unit

Public MustOverride Sub WriteAsync (documentPaginator As DocumentPaginator, userState As Object)

Parameters

documentPaginator

DocumentPaginator

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

userState

Object

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

Remarks

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.

See also

• Write(DocumentPaginator)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedPage)

When overridden in a derived class, asynchronously writes a given FixedPage to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Documents::FixedPage ^ fixedPage);

public abstract void WriteAsync (System.Windows.Documents.FixedPage fixedPage);

abstract member WriteAsync : System.Windows.Documents.FixedPage -> unit

Public MustOverride Sub WriteAsync (fixedPage As FixedPage)

Parameters

fixedPage

FixedPage

The page to write to the serialization Stream.

Remarks

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(FixedPage).

See also

• Write(FixedPage)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedDocumentSequence)

When overridden in a derived class, asynchronously writes a given FixedDocumentSequence to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence);

public abstract void WriteAsync (System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence);

abstract member WriteAsync : System.Windows.Documents.FixedDocumentSequence -> unit

Public MustOverride Sub WriteAsync (fixedDocumentSequence As FixedDocumentSequence)

Parameters

fixedDocumentSequence

FixedDocumentSequence

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

Remarks

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(FixedDocumentSequence).

See also

• Write(FixedDocumentSequence)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedDocument)

When overridden in a derived class, asynchronously writes a given FixedDocument to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Documents::FixedDocument ^ fixedDocument);

public abstract void WriteAsync (System.Windows.Documents.FixedDocument fixedDocument);

abstract member WriteAsync : System.Windows.Documents.FixedDocument -> unit

Public MustOverride Sub WriteAsync (fixedDocument As FixedDocument)

Parameters

fixedDocument

FixedDocument

The document to write to the serialization Stream.

Remarks

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(FixedDocument).

See also

• Write(FixedDocument)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(DocumentPaginator)

When overridden in a derived class, asynchronously writes the content of a given DocumentPaginator to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Documents::DocumentPaginator ^ documentPaginator);

public abstract void WriteAsync (System.Windows.Documents.DocumentPaginator documentPaginator);

abstract member WriteAsync : System.Windows.Documents.DocumentPaginator -> unit

Public MustOverride Sub WriteAsync (documentPaginator As DocumentPaginator)

Parameters

documentPaginator

DocumentPaginator

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

Remarks

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(DocumentPaginator).

See also

• Write(DocumentPaginator)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged

WriteAsync(FixedDocumentSequence, Object)

When overridden in a derived class, asynchronously writes a given FixedDocumentSequence to the serialization Stream.

public:
 abstract void WriteAsync(System::Windows::Documents::FixedDocumentSequence ^ fixedDocumentSequence, System::Object ^ userState);

public abstract void WriteAsync (System.Windows.Documents.FixedDocumentSequence fixedDocumentSequence, object userState);

abstract member WriteAsync : System.Windows.Documents.FixedDocumentSequence * obj -> unit

Public MustOverride Sub WriteAsync (fixedDocumentSequence As FixedDocumentSequence, userState As Object)

Parameters

fixedDocumentSequence

FixedDocumentSequence

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

userState

Object

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

Remarks

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.

See also

• Write(FixedDocumentSequence)
• CancelAsync()
• WritingCancelled
• WritingCompleted
• WritingProgressChanged