GdPicture.NET.14
GdPicture14 Namespace / GdPicturePDF Class / PrintGetPaperSize Method
Example





In This Topic
PrintGetPaperSize Method (GdPicturePDF)
In This Topic
Returns the current paper size, means the type of the paper, to be used by the active printer. The value is determined through the PaperSize.Kind property of the default page settings.
Syntax
'Declaration
 

Public Function PrintGetPaperSize() As Integer
public int PrintGetPaperSize()
public function PrintGetPaperSize(): Integer; 
public function PrintGetPaperSize() : int;
public: int PrintGetPaperSize(); 
public:
int PrintGetPaperSize();

Return Value

The constant that represents the current paper size. Please refer to the System.Drawing.Printing.PaperKind enumeration for correct values. Some of them are listed below (please see the corresponding ordering number):
  1. Letter, 8.5 x 11 in.
  2. Letter Small, 8.5 x 11 in.
  3. Tabloid, 11 x 17 in.
  4. Ledger, 17 x 11 in.
  5. Legal, 8.5 x 14 in.
  6. Statement, 5 1/2 x 8 1/2 in.
  7. Executive, 7 1/2 x 10 1/2 in.
  8. A3, 297 x 420 mm
  9. A4, 210 x 297 mm
  10. A4 Small, 210 x 297 mm
  11. A5, 148 x 210 mm
  12. B4, 250 x 354 mm
  13. B5, 182 x 257 mm
  14. Folio, 8.5 x 13 in.
  15. Quarto, 215 x 275 mm
  16. Standard 10 x 14 in.
  17. Standard 11 x 17 in.
  18. Note, 8.5 x 11 in.
  19. Envelope #9, 3 7/8 x 8 7/8 in.
  20. Envelope #10, 4 1/8 x 9.5 in.
  21. Envelope #11, 4.5 x 10 3/8 in.
  22. Envelope #12, 4.5 x 11 in.
  23. Envelope #14, 5 x 11.5 in.
  24. C size sheet
  25. D size sheet
  26. E size sheet
  27. Envelope DL, 110 x 220 mm
  28. Envelope C5, 162 x 229 mm
  29. Envelope C3, 324 x 458 mm
  30. Envelope C4, 229 x 324 mm
  31. Envelope C6, 114 x 162 mm
  32. Envelope C65, 114 x 229 mm
  33. Envelope B4, 250 x 353 mm
  34. Envelope B5, 176 x 250 mm
  35. Envelope B6, 176 x 125 mm
  36. Envelope Italy, 110 x 230 mm
  37. Envelope Monarch, 3 7/8 x 7.5 in.
  38. Envelope, 3 5/8 x 6.5 in.
  39. U.S. Standard Fanfold, 14 7/8 x 11 in.
  40. German Standard Fanfold, 8.5 x 12 in.
  41. German Legal Fanfold, 8 1/2 x 13 in.

42. and more Less-common international sizes.

118. and more Custom paper sizes.

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 find out some page properties of the active printer. 
Dim caption As String = "Example: PrintGetPaperSize"
Dim gdpicturePDF As New GdPicturePDF()
Dim message As String = ""
If gdpicturePDF.LoadFromFile("document_to_print.pdf", False) = GdPictureStatus.OK Then
    Dim curPrinter As String = gdpicturePDF.PrintGetActivePrinter()
    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
        message = "Active printer: " + curPrinter + vbCrLf
    Else
        message = "The PrintGetActivePrinter() method has failed with the status: " + gdpicturePDF.GetStat()
    End If
    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
        Dim leftMargin As Single = 0, rightMargin As Single = 0
        gdpicturePDF.PrintGetMargins(leftMargin, rightMargin)
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            message = message + "    margins: left = " + leftMargin.ToString() + ", right = " + rightMargin.ToString() + vbCrLf
        Else
            message = "The PrintGetMargins() method has failed with the status: " + gdpicturePDF.GetStat()
        End If
    End If
    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
        Dim prnBin As Integer = gdpicturePDF.PrintGetPaperBin()
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            message = message + "    paper bin: " + prnBin.ToString() + vbCrLf
        Else
            message = "The PrintGetPaperBin() method has failed with the status: " + gdpicturePDF.GetStat()
        End If
    End If
    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
        Dim prnSize As Integer = gdpicturePDF.PrintGetPaperSize()
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            message = message + "    paper size: " + prnSize.ToString() + vbCrLf
        Else
            message = "The PrintGetPaperSize() method has failed with the status: " + gdpicturePDF.GetStat()
        End If
    End If
    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
        Dim prnHeight As Single = gdpicturePDF.PrintGetPaperHeight()
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            message = message + "    paper height: " + prnHeight.ToString()
        Else
            message = "The PrintGetPaperHeight() method has failed with the status: " + gdpicturePDF.GetStat()
        End If
    End If
    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
        Dim prnWidth As Single = gdpicturePDF.PrintGetPaperWidth()
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            message = message + "    paper width: " + prnWidth.ToString() + vbCrLf
        Else
            message = "The PrintGetPaperWidth() method has failed with the status: " + gdpicturePDF.GetStat()
        End If
    End If
    If gdpicturePDF.GetStat() <> GdPictureStatus.OK Then
        message = "The example has NOT been followed successfully. Status: " + gdpicturePDF.GetStat().ToString()
    End If
Else
    message = "The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString()
End If
MessageBox.Show(message, caption)
gdpicturePDF.Dispose()
string caption = "Example: PrintGetPaperSize";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
string message = "";
if (gdpicturePDF.LoadFromFile("test.pdf", false) == GdPictureStatus.OK)
{
    string curPrinter = gdpicturePDF.PrintGetActivePrinter();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
        message = "Active printer: " + curPrinter + "\n";
    else
        message = "The PrintGetActivePrinter() method has failed with the status: " + gdpicturePDF.GetStat();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        float leftMargin = 0, rightMargin = 0;
        gdpicturePDF.PrintGetMargins(ref leftMargin, ref rightMargin);
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            message = message + "    margins: left = " + leftMargin.ToString() + ", right = " + rightMargin.ToString() + "\n";
        else
            message = "The PrintGetMargins() method has failed with the status: " + gdpicturePDF.GetStat();
    }
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        int prnBin = gdpicturePDF.PrintGetPaperBin();
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            message = message + "    paper bin: " + prnBin.ToString() + "\n";
        else
            message = "The PrintGetPaperBin() method has failed with the status: " + gdpicturePDF.GetStat();
    }
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        int prnSize = gdpicturePDF.PrintGetPaperSize();
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            message = message + "    paper size: " + prnSize.ToString() + "\n";
        else
            message = "The PrintGetPaperSize() method has failed with the status: " + gdpicturePDF.GetStat();
    }
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        float prnHeight = gdpicturePDF.PrintGetPaperHeight();
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            message = message + "    paper height: " + prnHeight.ToString();
        else
            message = "The PrintGetPaperHeight() method has failed with the status: " + gdpicturePDF.GetStat();
    }
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        float prnWidth = gdpicturePDF.PrintGetPaperWidth();
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            message = message + "    paper width: " + prnWidth.ToString() + "\n";
        else
            message = "The PrintGetPaperWidth() method has failed with the status: " + gdpicturePDF.GetStat();
    }
    if (gdpicturePDF.GetStat() != GdPictureStatus.OK)
    {
        message = "The example has NOT been followed successfully. Status: " + gdpicturePDF.GetStat().ToString();
    }
}
else
{
    message = "The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString();
}
MessageBox.Show(message, caption);
gdpicturePDF.Dispose();
See Also

Reference

GdPicturePDF Class
GdPicturePDF Members
PrintSetStdPaperSize Method
PrintSetUserPaperSize Method
PrintGetPaperWidth Method
PrintGetPaperHeight Method
PrintGetActivePrinter Method
PrintGetPrinterSettings Method
PrintSetActivePrinter Method
PrintSetPrinterSettings Method
PrintGetStat Method

 

 

Ⓒ Copyright 2024 Nutrient. All rights reserved