VisualsToXpsDocument Class

Provides methods for writing Visual objects to XML Paper Specification (XPS) documents or to a print queue in a batch mode.

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

public class VisualsToXpsDocument : SerializerWriterCollator
public class VisualsToXpsDocument extends SerializerWriterCollator
public class VisualsToXpsDocument extends SerializerWriterCollator
Not applicable.

Because this class has no constructor, use the CreateVisualsCollator method to create an instance.

The VisualsToXpsDocument writes to the same target XpsDocument or PrintQueue as the XpsDocumentWriter that creates the VisualsToXpsDocument.

Each Visual becomes a page in the document.

The following example shows how to create a visuals collator and use it to write to an XML Paper Specification (XPS) document.

private void SaveVisuals(XpsDocumentWriter xpsdw, List<Visual> vc)
    // Setup for writing multiple visuals
    VisualsToXpsDocument vToXpsD = (VisualsToXpsDocument)xpsdw.CreateVisualsCollator();

    // Iterate through all visuals in the collection
    foreach (Visual v in vc)
        vToXpsD.Write(v);   //Write each visual to single page

    // End writing multiple visuals

For the complete sample, see Saving an XPS Document Sample.

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions