The new value of the printer collate setting.
Example





In This Topic
GdPicture14.WPF Namespace / GdViewer Class / PrintSetCollate Method

PrintSetCollate Method (GdViewer)

In This Topic
Sets up the printer collate setting of the active printer. This property determines, whether the printed document is collated.

Setting it to true will print a complete copy of the document before the first page of the next copy is printed. Setting it to false will print each page by the number of copies specified before printing the next page.

Syntax
'Declaration

 


Public Function PrintSetCollate( _

   ByVal Collate As Boolean _

) As GdPictureStatus
public GdPictureStatus PrintSetCollate( 

   bool Collate

)
public function PrintSetCollate( 

    Collate: Boolean

): GdPictureStatus; 
public function PrintSetCollate( 

   Collate : boolean

) : GdPictureStatus;
public: GdPictureStatus PrintSetCollate( 

   bool Collate

) 
public:

GdPictureStatus PrintSetCollate( 

   bool Collate

)

Parameters

Collate
The new value of the printer collate setting.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks
It is recommend to use the GetStat method or the PrintGetStat method to identify the specific reason for the method's failure, if any.

Please note that collating is only performed when the number of copies is greater than 1.

Just to remind you that the active printer is the printer identified by the PrintGetActivePrinter method or set by the PrintSetActivePrinter method and it is dedicated to executing all subsequent print jobs using this class as well as utilizing all by you altered printer settings.

Example
How to set up some printer properties to be used for printing the displayed document. 
'We assume that the GdViewer1 control has been properly integrated.

Dim message As String = ""

Dim curPrinter As String = GdViewer1.PrintGetActivePrinter()

If GdViewer1.GetStat() = GdPictureStatus.OK Then

    message = "Active printer: " + curPrinter + vbCrLf

Else

    message = "The PrintGetActivePrinter() method has failed with the status: " + GdViewer1.GetStat()

End If

If GdViewer1.GetStat() = GdPictureStatus.OK Then

    GdViewer1.PrintSetAlignment(PrintAlignment.PrintAlignmentMiddleCenter)

    If GdViewer1.GetStat() = GdPictureStatus.OK Then

        message = message + "    alignment: MiddleCenter" + vbCrLf

    Else

        message = "The PrintSetAlignment() method has failed with the status: " + GdViewer1.GetStat()

    End If

End If

If GdViewer1.GetStat() = GdPictureStatus.OK Then

    GdViewer1.PrintSetAutoRotation(True)

    If GdViewer1.GetStat() = GdPictureStatus.OK Then

        message = message + "    auto-rotation: true" + vbCrLf

    Else

        message = "The PrintSetAutoRotation() method has failed with the status: " + GdViewer1.GetStat()

    End If

End If

If GdViewer1.GetStat() = GdPictureStatus.OK Then

    GdViewer1.PrintSetCollate(True)

    If GdViewer1.GetStat() = GdPictureStatus.OK Then

        message = message + "    collate: true" + vbCrLf

    Else

        message = "The PrintSetCollate() method has failed with the status: " + GdViewer1.GetStat()

    End If

End If

If GdViewer1.GetStat() = GdPictureStatus.OK Then

    GdViewer1.PrintSetColorMode(PrinterColorMode.PrinterColorModeColor)

    If GdViewer1.GetStat() = GdPictureStatus.OK Then

        message = message + "    color mode: Color" + vbCrLf

    Else

        message = "The PrintSetColorMode() method has failed with the status: " + GdViewer1.GetStat()

    End If

End If

If GdViewer1.GetStat() = GdPictureStatus.OK Then

    GdViewer1.PrintSetOrientation(PrinterOrientation.PrinterOrientationPortrait)

    If GdViewer1.GetStat() = GdPictureStatus.OK Then

        message = message + "    orientation: Portrait" + vbCrLf

    Else

        message = "The PrintSetOrientation() method has failed with the status: " + GdViewer1.GetStat()

    End If

End If

If GdViewer1.GetStat() = GdPictureStatus.OK Then

    GdViewer1.PrintSetQuality(PrintQuality.PrintQualityHighResolution)

    If GdViewer1.GetStat() = GdPictureStatus.OK Then

        message = message + "    quality: High" + vbCrLf

    Else

        message = "The PrintSetQuality() method has failed with the status: " + GdViewer1.GetStat()

    End If

End If

If GdViewer1.GetStat() = GdPictureStatus.OK Then

    'We assume that the required document is displayed in the GdViewer1 control.

    If GdViewer1.Print(PrintSizeOption.PrintSizeOptionActual) = GdPictureStatus.OK Then

        message = message + "The file has been printed successfully using new settings."

    Else

        message = message + "The file can't be printed." + vbCrLf + "Status: " + GdViewer1.PrintGetStat().ToString()

        If GdViewer1.PrintGetStat() = GdPictureStatus.PrintingException Then message = message + "    Error: " + GdViewer1.PrintGetLastError()

    End If

Else

    message = "The example has NOT been followed successfully. Status: " + GdViewer1.GetStat().ToString()

End If

MessageBox.Show(message, "GdViewer.PrintSetCollate")
//We assume that the GdViewer1 control has been properly integrated.

string message = "";

string curPrinter = GdViewer1.PrintGetActivePrinter();

if (GdViewer1.GetStat() == GdPictureStatus.OK)

    message = "Active printer: " + curPrinter + "\n";

else

    message = "The PrintGetActivePrinter() method has failed with the status: " + GdViewer1.GetStat();

if (GdViewer1.GetStat() == GdPictureStatus.OK)

{

    GdViewer1.PrintSetAlignment(PrintAlignment.PrintAlignmentMiddleCenter);

    if (GdViewer1.GetStat() == GdPictureStatus.OK)

        message = message + "    alignment: MiddleCenter\n";

    else

        message = "The PrintSetAlignment() method has failed with the status: " + GdViewer1.GetStat();

}

if (GdViewer1.GetStat() == GdPictureStatus.OK)

{

    GdViewer1.PrintSetAutoRotation(true);

    if (GdViewer1.GetStat() == GdPictureStatus.OK)

        message = message + "    auto-rotation: true\n";

    else

        message = "The PrintSetAutoRotation() method has failed with the status: " + GdViewer1.GetStat();

}

if (GdViewer1.GetStat() == GdPictureStatus.OK)

{

    GdViewer1.PrintSetCollate(true);

    if (GdViewer1.GetStat() == GdPictureStatus.OK)

        message = message + "    collate: true\n";

    else

        message = "The PrintSetCollate() method has failed with the status: " + GdViewer1.GetStat();

}

if (GdViewer1.GetStat() == GdPictureStatus.OK)

{

    GdViewer1.PrintSetColorMode(PrinterColorMode.PrinterColorModeColor);

    if (GdViewer1.GetStat() == GdPictureStatus.OK)

        message = message + "    color mode: Color\n";

    else

        message = "The PrintSetColorMode() method has failed with the status: " + GdViewer1.GetStat();

}

if (GdViewer1.GetStat() == GdPictureStatus.OK)

{

    GdViewer1.PrintSetOrientation(PrinterOrientation.PrinterOrientationPortrait);

    if (GdViewer1.GetStat() == GdPictureStatus.OK)

        message = message + "    orientation: Portrait\n";

    else

        message = "The PrintSetOrientation() method has failed with the status: " + GdViewer1.GetStat();

}

if (GdViewer1.GetStat() == GdPictureStatus.OK)

{

    GdViewer1.PrintSetQuality(PrintQuality.PrintQualityHighResolution);

    if (GdViewer1.GetStat() == GdPictureStatus.OK)

        message = message + "    quality: High\n";

    else

        message = "The PrintSetQuality() method has failed with the status: " + GdViewer1.GetStat();

}

if (GdViewer1.GetStat() == GdPictureStatus.OK)

{

    //We assume that the required document is displayed in the GdViewer1 control.

    if (GdViewer1.Print(PrintSizeOption.PrintSizeOptionActual) == GdPictureStatus.OK)

    {

        message = message + "The file has been printed successfully using new settings.";

    }

    else

    {

        message = message + "The file can't be printed.\nStatus: " + GdViewer1.PrintGetStat().ToString();

        if (GdViewer1.PrintGetStat() == GdPictureStatus.PrintingException)

            message = message + "    Error: " + GdViewer1.PrintGetLastError();

    }

}

else

{

    message = "The example has NOT been followed successfully. Status: " + GdViewer1.GetStat().ToString();

}

MessageBox.Show(message, "GdViewer.PrintSetCollate");
See Also

Reference

GdViewer Class
GdViewer Members
PrintGetCollate Method
PrintGetActivePrinter Method
PrintSetActivePrinter Method
PrintGetStat Method