PrintSetUserPaperSize Method (GdViewer)

In This Topic

Sets up a custom paper size to be used by the active printer.

Syntax

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

'Declaration
 
Public Function PrintSetUserPaperSize( _
   ByVal PaperWidth As Single, _
   ByVal PaperHeight As Single _
) As GdPictureStatus

public GdPictureStatus PrintSetUserPaperSize( 
   float PaperWidth,
   float PaperHeight
)

public function PrintSetUserPaperSize( 
    PaperWidth: Single;
    PaperHeight: Single
): GdPictureStatus;

public function PrintSetUserPaperSize( 
   PaperWidth : float,
   PaperHeight : float
) : GdPictureStatus;

public: GdPictureStatus PrintSetUserPaperSize( 
   float PaperWidth,
   float PaperHeight
)

public:
GdPictureStatus PrintSetUserPaperSize( 
   float PaperWidth,
   float PaperHeight
)

Parameters

PaperWidth: The custom paper width to be used, in inches.
PaperHeight: The custom paper height to be used, in inches.

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 set up some printer properties to be used for printing the displayed document.

VB.NET
C#

'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
    If GdViewer1.PrintSetPaperBin(7) Then
        message = message + "    paper bin: 7 (automatic feed)" + vbCrLf
    Else
        message = "The PrintSetPaperBin() method has failed with the status: " + GdViewer1.GetStat()
    End If
End If
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    GdViewer1.PrintSetUserPaperSize(120, 250)
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        message = message + "    paper size: 120, 250" + vbCrLf
    Else
        message = "The PrintSetUserPaperSize() method has failed with the status: " + GdViewer1.GetStat()
    End If
End If
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    GdViewer1.PrintSetFromToPage(2, 4)
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        message = message + "    page range: 2-4" + vbCrLf
    Else
        message = "The PrintSetFromToPage() 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() = 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.PrintSetUserPaperSize")

//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)
{
    if (GdViewer1.PrintSetPaperBin(7))
        message = message + "    paper bin: 7 (automatic feed)\n";
    else
        message = "The PrintSetPaperBin() method has failed with the status: " + GdViewer1.GetStat();
}
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
    GdViewer1.PrintSetUserPaperSize(120, 250);
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
        message = message + "    paper size: 120, 250\n";
    else
        message = "The PrintSetUserPaperSize() method has failed with the status: " + GdViewer1.GetStat();
}
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
    GdViewer1.PrintSetFromToPage(2, 4);
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
        message = message + "    page range: 2-4\n";
    else
        message = "The PrintSetFromToPage() 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() == 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.PrintSetUserPaperSize");

Reference

GdViewer Class
GdViewer Members
PrintSetStdPaperSize Method
PrintGetPaperSize Method
PrintGetActivePrinter Method
PrintGetPrinterSettings Method
PrintSetActivePrinter Method
PrintSetPrinterSettings Method
PrintGetStat Method
Print Method