Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / PrintGetPaperHeight Method

PrintGetPaperHeight Method (GdPicturePDF)

In This Topic
Returns the height of the paper to be used by the active printer.
Syntax
'Declaration

 


Public Function PrintGetPaperHeight() As Single
public float PrintGetPaperHeight()
public function PrintGetPaperHeight(): Single; 
public function PrintGetPaperHeight() : float;
public: float PrintGetPaperHeight(); 
public:

float PrintGetPaperHeight();

Return Value

The paper height, in inches. 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: PrintGetPaperHeight"

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: PrintGetPaperHeight";

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();
Example
How to find out some page properties of the active printer. Dim caption As String = "Example: PrintGetPaperHeight" 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: PrintGetPaperHeight"; 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
GetStat Method
PrintGetStat Method
PrintGetActivePrinter Method
PrintSetActivePrinter Method
GetStat Method
PrintGetStat Method
PrintGetPaperWidth Method
PrintGetPaperSize Method
PrintSetUserPaperSize Method
PrintSetStdPaperSize Method
PrintGetActivePrinter Method
PrintGetPrinterSettings Method
PrintSetActivePrinter Method
PrintSetPrinterSettings Method
PrintGetStat Method