PrintSetCopies Method (GdPicturePDF)

In This Topic

Sets up the printer copies setting of the active printer, that means the number of copies to be printed.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function PrintSetCopies( _
   ByVal Copies As Short _
) As GdPictureStatus

public GdPictureStatus PrintSetCopies( 
   short Copies
)

public function PrintSetCopies( 
    Copies: Int16
): GdPictureStatus;

public function PrintSetCopies( 
   Copies : short
) : GdPictureStatus;

public: GdPictureStatus PrintSetCopies( 
   short Copies
)

public:
GdPictureStatus PrintSetCopies( 
   short Copies
)

Parameters

Copies: The number of copies to be printed. The new value of the active printer copies 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.

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 increase the number of copies to be printed using the active printer.

VB.NET
C#

Dim caption As String = "Example: PrintSetCopies"
Using gdpicturePDF As New GdPicturePDF()
    If gdpicturePDF.LoadFromFile("document_to_print.pdf", False) = GdPictureStatus.OK Then
        Dim prnCopies As Short = gdpicturePDF.PrintGetCopies()
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            gdpicturePDF.PrintSetCopies(prnCopies + 2)
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                If gdpicturePDF.Print() = GdPictureStatus.OK Then
                    MessageBox.Show("The file has been printed successfully. Number of copies: " + (prnCopies+2).ToString(), caption)
                Else
                    Dim message As String = "The file can't be printed." + vbCrLf + "Status: " + gdpicturePDF.PrintGetStat().ToString()
                    If gdpicturePDF.PrintGetStat() = GdPictureStatus.PrintingException Then
                        message = message + "    Error: " + gdpicturePDF.PrintGetLastError()
                    End If
                    MessageBox.Show(message, caption)
                End If
            Else
                MessageBox.Show("The PrintSetCopies() method has failed with the status: " + gdpicturePDF.GetStat(), caption)
            End If
        Else
            MessageBox.Show("The PrintGetCopies() method has failed with the status: " + gdpicturePDF.GetStat(), caption)
        End If
        gdpicturePDF.CloseDocument()
    Else
        MessageBox.Show("The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString(), caption)
    End If
End Using

string caption = "Example: PrintSetCopies";
using (GdPicturePDF gdpicturePDF = new GdPicturePDF())
{
    if (gdpicturePDF.LoadFromFile("document_to_print.pdf", false) == GdPictureStatus.OK)
    {
        short prnCopies = gdpicturePDF.PrintGetCopies();
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
        {
            gdpicturePDF.PrintSetCopies((short)(prnCopies + 2));
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                if (gdpicturePDF.Print() == GdPictureStatus.OK)
                {
                    MessageBox.Show("The file has been printed successfully. Number of copies: " + (prnCopies+2).ToString(), caption);
                }
                else
                {
                    string message = "The file can't be printed.\nStatus: " + gdpicturePDF.PrintGetStat().ToString();
                    if (gdpicturePDF.PrintGetStat() == GdPictureStatus.PrintingException)
                        message = message + "    Error: " + gdpicturePDF.PrintGetLastError();
                    MessageBox.Show(message, caption);
                }
            }
            else
            {
                MessageBox.Show("The PrintSetCopies() method has failed with the status: " + gdpicturePDF.GetStat(), caption);
            }
        }
        else
        {
            MessageBox.Show("The PrintGetCopies() method has failed with the status: " + gdpicturePDF.GetStat(), caption);
        }
        gdpicturePDF.CloseDocument();
    }
    else
    {
        MessageBox.Show("The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString(), caption);
    }
}

Reference

GdPicturePDF Class
GdPicturePDF Members
PrintGetCopies Method
PrintGetActivePrinter Method
PrintGetPrinterSettings Method
PrintSetActivePrinter Method
PrintSetPrinterSettings Method
PrintGetStat Method
Print Method