XpsDocumentWriter Class

XpsDocumentWriter Class

 

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

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


public class XpsDocumentWriter : SerializerWriter

NameDescription
System_CAPS_pubmethodCancelAsync()

Cancels the current WriteAsync operation.(Overrides SerializerWriter.CancelAsync().)

System_CAPS_pubmethodCreateVisualsCollator()

Returns a VisualsToXpsDocument that can write Visual objects to a document or print queue.(Overrides SerializerWriter.CreateVisualsCollator().)

System_CAPS_pubmethodCreateVisualsCollator(PrintTicket, PrintTicket)

Returns a VisualsToXpsDocument that can write Visual objects with PrintTicket settings to an XPS document or print queue.(Overrides SerializerWriter.CreateVisualsCollator(PrintTicket, PrintTicket).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(DocumentPaginator)

Writes synchronously paginated content from a specified DocumentPaginator to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(DocumentPaginator).)

System_CAPS_pubmethodWrite(DocumentPaginator, PrintTicket)

Writes synchronously paginated content from a specified DocumentPaginator together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(DocumentPaginator, PrintTicket).)

System_CAPS_pubmethodWrite(FixedDocument)

Writes synchronously a specified FixedDocument to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(FixedDocument).)

System_CAPS_pubmethodWrite(FixedDocument, PrintTicket)

Writes synchronously a FixedDocument together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(FixedDocument, PrintTicket).)

System_CAPS_pubmethodWrite(FixedDocumentSequence)

Writes synchronously a specified FixedDocumentSequence to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(FixedDocumentSequence).)

System_CAPS_pubmethodWrite(FixedDocumentSequence, PrintTicket)

Writes synchronously a specified FixedDocumentSequence together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(FixedDocumentSequence, PrintTicket).)

System_CAPS_pubmethodWrite(FixedPage)

Writes synchronously a specified FixedPage to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(FixedPage).)

System_CAPS_pubmethodWrite(FixedPage, PrintTicket)

Writes synchronously a specified FixedPage together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(FixedPage, PrintTicket).)

System_CAPS_pubmethodWrite(String)

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

System_CAPS_pubmethodWrite(String, XpsDocumentNotificationLevel)

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

System_CAPS_pubmethodWrite(Visual)

Writes synchronously a specified Visual to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(Visual).)

System_CAPS_pubmethodWrite(Visual, PrintTicket)

Writes synchronously a specified Visual together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.Write(Visual, PrintTicket).)

System_CAPS_pubmethodWriteAsync(DocumentPaginator)

Writes asynchronously paginated content from a specified DocumentPaginator to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(DocumentPaginator).)

System_CAPS_pubmethodWriteAsync(DocumentPaginator, Object)

Writes asynchronously paginated content from a specified DocumentPaginator to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(DocumentPaginator, Object).)

System_CAPS_pubmethodWriteAsync(DocumentPaginator, PrintTicket)

Writes asynchronously paginated content from a specified DocumentPaginator together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(DocumentPaginator, PrintTicket).)

System_CAPS_pubmethodWriteAsync(DocumentPaginator, PrintTicket, Object)

Writes asynchronously paginated content from a specified DocumentPaginator together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(DocumentPaginator, PrintTicket, Object).)

System_CAPS_pubmethodWriteAsync(FixedDocument)

Writes asynchronously a specified FixedDocument to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedDocument).)

System_CAPS_pubmethodWriteAsync(FixedDocument, Object)

Writes asynchronously a specified FixedDocument to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedDocument, Object).)

System_CAPS_pubmethodWriteAsync(FixedDocument, PrintTicket)

Writes asynchronously a specified FixedDocument together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedDocument, PrintTicket).)

System_CAPS_pubmethodWriteAsync(FixedDocument, PrintTicket, Object)

Writes asynchronously a specified FixedDocument together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedDocument, PrintTicket, Object).)

System_CAPS_pubmethodWriteAsync(FixedDocumentSequence)

Writes asynchronously a specified FixedDocumentSequence to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedDocumentSequence).)

System_CAPS_pubmethodWriteAsync(FixedDocumentSequence, Object)
System_CAPS_pubmethodWriteAsync(FixedDocumentSequence, PrintTicket)

Writes asynchronously a specified FixedDocumentSequence together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedDocumentSequence, PrintTicket).)

System_CAPS_pubmethodWriteAsync(FixedDocumentSequence, PrintTicket, Object)
System_CAPS_pubmethodWriteAsync(FixedPage)

Writes asynchronously a specified FixedPage to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedPage).)

System_CAPS_pubmethodWriteAsync(FixedPage, Object)

Writes asynchronously a specified FixedPage to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedPage, Object).)

System_CAPS_pubmethodWriteAsync(FixedPage, PrintTicket)

Writes asynchronously a specified FixedPage together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedPage, PrintTicket).)

System_CAPS_pubmethodWriteAsync(FixedPage, PrintTicket, Object)

Writes asynchronously a specified FixedPage together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(FixedPage, PrintTicket, Object).)

System_CAPS_pubmethodWriteAsync(String)

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

System_CAPS_pubmethodWriteAsync(String, XpsDocumentNotificationLevel)

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

System_CAPS_pubmethodWriteAsync(Visual)

Writes asynchronously a specified Visual to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(Visual).)

System_CAPS_pubmethodWriteAsync(Visual, Object)

Writes asynchronously a specified Visual to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(Visual, Object).)

System_CAPS_pubmethodWriteAsync(Visual, PrintTicket)

Writes asynchronously a specified Visual together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(Visual, PrintTicket).)

System_CAPS_pubmethodWriteAsync(Visual, PrintTicket, Object)

Writes asynchronously a specified Visual together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter.WriteAsync(Visual, PrintTicket, Object).)

NameDescription
_WritingCancelled

Occurs when a Write or WriteAsync operation is canceled.

_WritingCompleted

Occurs when a write operation finishes.

_WritingProgressChanged

Occurs when the XpsDocumentWriter updates its progress.

System_CAPS_pubeventWritingCancelled

Occurs when a Write or WriteAsync operation is canceled.(Overrides SerializerWriter.WritingCancelled.)

System_CAPS_pubeventWritingCompleted

Occurs when a write operation finishes.(Overrides SerializerWriter.WritingCompleted.)

System_CAPS_pubeventWritingPrintTicketRequired

Occurs just before a Write or WriteAsync method adds a PrintTicket to a document or print queue.(Overrides SerializerWriter.WritingPrintTicketRequired.)

System_CAPS_pubeventWritingProgressChanged

Occurs when the XpsDocumentWriter updates its progress.(Overrides SerializerWriter.WritingProgressChanged.)

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.

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


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

XpsDocumentWriter xpsdw = XpsDocument.CreateXpsDocumentWriter(_xpsDocument);

.NET Framework
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft