XpsDocumentWriter Class

.NET Framework (current version)

Other Versions

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

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

Inheritance Hierarchy

System::Object
System.Windows.Documents.Serialization::SerializerWriter
System.Windows.Xps::XpsDocumentWriter

Syntax

C++

public ref class XpsDocumentWriter : SerializerWriter

Methods

	Name	Description
	CancelAsync()	Cancels the current WriteAsync operation.(Overrides SerializerWriter::CancelAsync().)
	CreateVisualsCollator()	Returns a VisualsToXpsDocument that can write Visual objects to a document or print queue.(Overrides SerializerWriter::CreateVisualsCollator().)
	CreateVisualsCollator(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^).)
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(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.)
	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.(Overrides SerializerWriter::Write(DocumentPaginator^).)
	Write(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^).)
	Write(FixedDocument^)	Writes synchronously a specified FixedDocument to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::Write(FixedDocument^).)
	Write(FixedDocument^, PrintTicket^)	Writes synchronously a FixedDocument together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::Write(FixedDocument^, PrintTicket^).)
	Write(FixedDocumentSequence^)	Writes synchronously a specified FixedDocumentSequence to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::Write(FixedDocumentSequence^).)
	Write(FixedDocumentSequence^, PrintTicket^)	Writes synchronously a specified FixedDocumentSequence together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::Write(FixedDocumentSequence^, PrintTicket^).)
	Write(FixedPage^)	Writes synchronously a specified FixedPage to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::Write(FixedPage^).)
	Write(FixedPage^, PrintTicket^)	Writes synchronously a specified FixedPage together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::Write(FixedPage^, PrintTicket^).)
	Write(String^)	Writes synchronously 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.(Overrides SerializerWriter::Write(Visual^).)
	Write(Visual^, PrintTicket^)	Writes synchronously a specified Visual together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::Write(Visual^, PrintTicket^).)
	WriteAsync(DocumentPaginator^)	Writes asynchronously paginated content from a specified DocumentPaginator to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(DocumentPaginator^).)
	WriteAsync(DocumentPaginator^, Object^)	Writes asynchronously paginated content from a specified DocumentPaginator to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(DocumentPaginator^, Object^).)
	WriteAsync(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^).)
	WriteAsync(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^).)
	WriteAsync(FixedDocument^)	Writes asynchronously a specified FixedDocument to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedDocument^).)
	WriteAsync(FixedDocument^, Object^)	Writes asynchronously a specified FixedDocument to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedDocument^, Object^).)
	WriteAsync(FixedDocument^, PrintTicket^)	Writes asynchronously a specified FixedDocument together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedDocument^, PrintTicket^).)
	WriteAsync(FixedDocument^, PrintTicket^, Object^)	Writes asynchronously a specified FixedDocument together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedDocument^, PrintTicket^, Object^).)
	WriteAsync(FixedDocumentSequence^)	Writes asynchronously a specified FixedDocumentSequence to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedDocumentSequence^).)
	WriteAsync(FixedDocumentSequence^, Object^)	Writes asynchronously a specified FixedDocumentSequence to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedDocumentSequence^, Object^).)
	WriteAsync(FixedDocumentSequence^, PrintTicket^)	Writes asynchronously a specified FixedDocumentSequence together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedDocumentSequence^, PrintTicket^).)
	WriteAsync(FixedDocumentSequence^, PrintTicket^, Object^)	Writes asynchronously a specified FixedDocumentSequence together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedDocumentSequence^, PrintTicket^, Object^).)
	WriteAsync(FixedPage^)	Writes asynchronously a specified FixedPage to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedPage^).)
	WriteAsync(FixedPage^, Object^)	Writes asynchronously a specified FixedPage to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedPage^, Object^).)
	WriteAsync(FixedPage^, PrintTicket^)	Writes asynchronously a specified FixedPage together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedPage^, PrintTicket^).)
	WriteAsync(FixedPage^, PrintTicket^, Object^)	Writes asynchronously a specified FixedPage together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(FixedPage^, PrintTicket^, Object^).)
	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.(Overrides SerializerWriter::WriteAsync(Visual^).)
	WriteAsync(Visual^, Object^)	Writes asynchronously a specified Visual to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(Visual^, Object^).)
	WriteAsync(Visual^, PrintTicket^)	Writes asynchronously a specified Visual together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(Visual^, PrintTicket^).)
	WriteAsync(Visual^, PrintTicket^, Object^)	Writes asynchronously a specified Visual together with a PrintTicket to the target XpsDocument or PrintQueue.(Overrides SerializerWriter::WriteAsync(Visual^, PrintTicket^, Object^).)

Events

	Name	Description
	_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.
	WritingCancelled	Occurs when a Write or WriteAsync operation is canceled.(Overrides SerializerWriter::WritingCancelled.)
	WritingCompleted	Occurs when a write operation finishes.(Overrides SerializerWriter::WritingCompleted.)
	WritingPrintTicketRequired	Occurs just before a Write or WriteAsync method adds a PrintTicket to a document or print queue.(Overrides SerializerWriter::WritingPrintTicketRequired.)
	WritingProgressChanged	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.