XpsDocumentWriter Class

Definition

Provides methods to write to an XPS document or print queue.

public ref class XpsDocumentWriter : System::Windows::Documents::Serialization::SerializerWriter
public class XpsDocumentWriter : System.Windows.Documents.Serialization.SerializerWriter
type XpsDocumentWriter = class
    inherit SerializerWriter
Public Class XpsDocumentWriter
Inherits SerializerWriter
Inheritance
XpsDocumentWriter

Examples

The following example shows how to create an instance of the XpsDocumentWriter class.


_xpsDocument = new XpsDocument(containerName,FileAccess.ReadWrite);

XpsDocumentWriter xpsdw = XpsDocument.CreateXpsDocumentWriter(_xpsDocument);

_xpsDocument = New XpsDocument(containerName,FileAccess.ReadWrite)

Dim xpsdw As XpsDocumentWriter = XpsDocument.CreateXpsDocumentWriter(_xpsDocument)

Remarks

XpsDocumentWriter has no constructor. To create an XpsDocumentWriter, use the static CreateXpsDocumentWriter method of the XpsDocument class or use one of the static CreateXpsDocumentWriter methods of the PrintQueue class. The document or the queue that creates the XpsDocumentWriter becomes the target to which it writes.

Methods

CancelAsync()

Cancels the current WriteAsync operation.

CreateVisualsCollator()

Returns a VisualsToXpsDocument that can write Visual objects to a document or print queue.

CreateVisualsCollator(PrintTicket, PrintTicket)

Returns a VisualsToXpsDocument that can write Visual objects with PrintTicket settings to an XPS document or print queue.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
raise_WritingCancelled(Object, WritingCancelledEventArgs)

Raises the WritingCancelled event.

raise_WritingCompleted(Object, WritingCompletedEventArgs)

Raises the WritingCompleted event.

raise_WritingPrintTicketRequired(Object, WritingPrintTicketRequiredEventArgs)

Raises the WritingPrintTicketRequired event.

raise_WritingProgressChanged(Object, WritingProgressChangedEventArgs)

Raises the WritingProgressChanged event.

ToString()

Returns a string that represents the current object.

(Inherited from Object)
Write(DocumentPaginator)

Writes synchronously paginated content from a specified DocumentPaginator to the target XpsDocument or PrintQueue.

Write(DocumentPaginator, PrintTicket)

Writes synchronously paginated content from a specified DocumentPaginator together with a PrintTicket to the target XpsDocument or PrintQueue.

Write(FixedDocument)

Writes synchronously a specified FixedDocument to the target XpsDocument or PrintQueue.

Write(FixedDocument, PrintTicket)

Writes synchronously a FixedDocument together with a PrintTicket to the target XpsDocument or PrintQueue.

Write(FixedDocumentSequence)

Writes synchronously a specified FixedDocumentSequence to the target XpsDocument or PrintQueue.

Write(FixedDocumentSequence, PrintTicket)

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

Write(FixedPage)

Writes synchronously a specified FixedPage to the target XpsDocument or PrintQueue.

Write(FixedPage, PrintTicket)

Writes synchronously a specified FixedPage together with a PrintTicket to the target XpsDocument or PrintQueue.

Write(String)

Synchronously writes a specified XPS document to the target XpsDocument or PrintQueue.

Write(String, XpsDocumentNotificationLevel)

Writes synchronously a specified XPS document to the target XpsDocument or PrintQueue.

Write(Visual)

Writes synchronously a specified Visual to the target XpsDocument or PrintQueue.

Write(Visual, PrintTicket)

Writes synchronously a specified Visual together with a PrintTicket to the target XpsDocument or PrintQueue.

WriteAsync(DocumentPaginator)

Writes asynchronously paginated content from a specified DocumentPaginator to the target XpsDocument or PrintQueue.

WriteAsync(DocumentPaginator, Object)

Writes asynchronously paginated content from a specified DocumentPaginator to the target XpsDocument or PrintQueue.

WriteAsync(DocumentPaginator, PrintTicket)

Writes asynchronously paginated content from a specified DocumentPaginator together with a PrintTicket to the target XpsDocument or PrintQueue.

WriteAsync(DocumentPaginator, PrintTicket, Object)

Writes asynchronously paginated content from a specified DocumentPaginator together with a PrintTicket to the target XpsDocument or PrintQueue.

WriteAsync(FixedDocument)

Writes asynchronously a specified FixedDocument to the target XpsDocument or PrintQueue.

WriteAsync(FixedDocument, Object)

Writes asynchronously a specified FixedDocument to the target XpsDocument or PrintQueue.

WriteAsync(FixedDocument, PrintTicket)

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

WriteAsync(FixedDocument, PrintTicket, Object)

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

WriteAsync(FixedDocumentSequence)

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

WriteAsync(FixedDocumentSequence, Object)

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

WriteAsync(FixedDocumentSequence, PrintTicket)

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

WriteAsync(FixedDocumentSequence, PrintTicket, Object)

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

WriteAsync(FixedPage)

Writes asynchronously a specified FixedPage to the target XpsDocument or PrintQueue.

WriteAsync(FixedPage, Object)

Writes asynchronously a specified FixedPage to the target XpsDocument or PrintQueue.

WriteAsync(FixedPage, PrintTicket)

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

WriteAsync(FixedPage, PrintTicket, Object)

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

WriteAsync(String)

Writes asynchronously a specified XPS document to the target XpsDocument or PrintQueue.

WriteAsync(String, XpsDocumentNotificationLevel)

Writes asynchronously a specified XPS document with notification option to the target XpsDocument or PrintQueue.

WriteAsync(Visual)

Writes asynchronously a specified Visual to the target XpsDocument or PrintQueue.

WriteAsync(Visual, Object)

Writes asynchronously a specified Visual to the target XpsDocument or PrintQueue.

WriteAsync(Visual, PrintTicket)

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

WriteAsync(Visual, PrintTicket, Object)

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

Events

WritingCancelled

Occurs when a Write or WriteAsync operation is canceled.

WritingCompleted

Occurs when a write operation finishes.

WritingPrintTicketRequired

Occurs just before a Write or WriteAsync method adds a PrintTicket to a document or print queue.

WritingProgressChanged

Occurs when the XpsDocumentWriter updates its progress.

Applies to