CreateVisualsCollator Method (PrintTicket, PrintTicket)

SerializerWriter.CreateVisualsCollator Method (PrintTicket, PrintTicket)

When overridden in a derived class, returns a SerializerWriterCollator that writes collated Visual elements together with the given print tickets.

Namespace:  System.Windows.Documents.Serialization
Assembly:  PresentationFramework (in PresentationFramework.dll)

public abstract SerializerWriterCollator CreateVisualsCollator(
	PrintTicket documentSequencePT,
	PrintTicket documentPT
You cannot use methods in XAML.


Type: System.Printing.PrintTicket

The default print preferences for FixedDocumentSequence content.

Type: System.Printing.PrintTicket

The default print preferences for FixedDocument content.

Return Value

Type: System.Windows.Documents.Serialization.SerializerWriterCollator
A SerializerWriterCollator that writes collated Visual elements to the document output serialization Stream.

documentSequencePT or documentPT can be null if there are no preferred print settings.

This method does not validate or modify the given print tickets for a particular PrintQueue. If needed, use the PrintQueue.MergeAndValidatePrintTicket method to create a PrintQueue-specific PrintTicket that is valid for a given printer.

Notes to Implementers:

CreateVisualsCollator should return a SerializerWriterCollator that writes to the same serialization Stream as the SerializerWriter that creates it.

The following example shows the use of the CreateVisualsCollator method. For the complete sample, see Saving an XPS Document Sample.

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

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0

Community Additions

© 2016 Microsoft