PrintGetCopies Method (GdViewer)

In This Topic

Returns 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 PrintGetCopies() As Short

public short PrintGetCopies()

public function PrintGetCopies(): Int16;

public function PrintGetCopies() : short;

public: short PrintGetCopies();

public:
short PrintGetCopies();

Return Value

The number of copies to be printed. The value of the active printer copies setting.

The GetStat method can be subsequently used or the PrintGetStat method to determine if this method has been successful.

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#

'We assume that the GdViewer1 control has been properly integrated.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
    Dim prnCopies As Short = GdViewer1.PrintGetCopies()
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        GdViewer1.PrintSetCopies(CShort((prnCopies + 2)))
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            If GdViewer1.Print() = GdPictureStatus.OK Then
                MessageBox.Show("The file has been printed successfully. Number of copies: " + (prnCopies + 2).ToString(), "GdViewer.PrintGetCopies")
            Else
                Dim message As String = "The file can't be printed." + vbCrLf + "Status: " + GdViewer1.PrintGetStat().ToString()
                If GdViewer1.PrintGetStat() = GdPictureStatus.PrintingException Then message = message + "    Error: " + GdViewer1.PrintGetLastError()
                MessageBox.Show(message, "GdViewer.PrintGetCopies")
            End If
        Else
            MessageBox.Show("The PrintSetCopies() method has failed with the status: " + GdViewer1.GetStat(), "GdViewer.PrintGetCopies")
        End If
    Else
        MessageBox.Show("The PrintGetCopies() method has failed with the status: " + GdViewer1.GetStat(), "GdViewer.PrintGetCopies")
    End If
    GdViewer1.CloseDocument()
Else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.PrintGetCopies")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    short prnCopies = GdViewer1.PrintGetCopies();
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
    {
        GdViewer1.PrintSetCopies((short)(prnCopies + 2));
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
        {
            if (GdViewer1.Print() == GdPictureStatus.OK)
            {
                MessageBox.Show("The file has been printed successfully. Number of copies: " + (prnCopies + 2).ToString(), "GdViewer.PrintGetCopies");
            }
            else
            {
                string message = "The file can't be printed.\nStatus: " + GdViewer1.PrintGetStat().ToString();
                if (GdViewer1.PrintGetStat() == GdPictureStatus.PrintingException)
                    message = message + "    Error: " + GdViewer1.PrintGetLastError();
                MessageBox.Show(message, "GdViewer.PrintGetCopies");
            }
        }
        else
        {
            MessageBox.Show("The PrintSetCopies() method has failed with the status: " + GdViewer1.GetStat(), "GdViewer.PrintGetCopies");
        }
    }
    else
    {
        MessageBox.Show("The PrintGetCopies() method has failed with the status: " + GdViewer1.GetStat(), "GdViewer.PrintGetCopies");
    }
    GdViewer1.CloseDocument();
}
else
{
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.PrintGetCopies");
}

Reference

GdViewer Class
GdViewer Members
PrintSetCopies Method
PrintGetActivePrinter Method
PrintGetPrinterSettings Method
PrintSetActivePrinter Method
PrintSetPrinterSettings Method
PrintGetStat Method
Print Method