Reference Guide
GdPicture14.WPF Namespace / GdViewer Class / PrintGetPaperBin Method
Example





In This Topic
    PrintGetPaperBin Method (GdViewer)
    In This Topic
    Returns the paper source, means the paper tray, from which the printer gets paper, used by the active printer. The value is determined through the PaperSource.Kind property of the default page settings.
    Syntax
    'Declaration
     
    
    Public Function PrintGetPaperBin() As Integer
    public int PrintGetPaperBin()
    public function PrintGetPaperBin(): Integer; 
    public function PrintGetPaperBin() : int;
    public: int PrintGetPaperBin(); 
    public:
    int PrintGetPaperBin(); 

    Return Value

    The constant that represents the current paper source. Please refer to the System.Drawing.Printing.PaperSourceKind enumeration for correct values. The standard values are listed below (please see the corresponding ordering number):
    1. Upper
    2. Lower
    3. Middle
    4. Manual
    5. Enveloper
    6. ManualFeed
    7. AutomaticFeed
    8. TractorFeed
    9. SmallFormat
    10. LargeFormat
    11. LargeCapacity

    14. Cassette

    15. FormSource

    257. or greater: Custom

    Please always use the GetStat method or the PrintGetStat method to determine if this method has been successful.

    Remarks
    We strongly recommend using the GetStat method or the PrintGetStat method to identify the specific reason for the method's failure.

    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.
    '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
        Dim leftMargin As Single = 0, rightMargin As Single = 0
        GdViewer1.PrintGetMargins(leftMargin, rightMargin)
                
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            message = message + "    margins: left = " + leftMargin.ToString() + ", right = " + rightMargin.ToString() + vbCrLf
        Else
            message = "The PrintGetMargins() method has failed with the status: " + GdViewer1.GetStat()
        End If
    End If
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        Dim prnBin As Integer = GdViewer1.PrintGetPaperBin()
                
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            message = message + "    paper bin: " + prnBin.ToString() + vbCrLf
        Else
            message = "The PrintGetPaperBin() method has failed with the status: " + GdViewer1.GetStat()
        End If
    End If
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        Dim prnSize As Integer = GdViewer1.PrintGetPaperSize()
                
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            message = message + "    paper size: " + prnSize.ToString() + vbCrLf
        Else
            message = "The PrintGetPaperSize() method has failed with the status: " + GdViewer1.GetStat()
        End If
    End If
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        Dim prnHeight As Single = GdViewer1.PrintGetPaperHeight()
                
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            message = message + "    paper height: " + prnHeight.ToString()
        Else
            message = "The PrintGetPaperHeight() method has failed with the status: " + GdViewer1.GetStat()
        End If
    End If
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        Dim prnWidth As Single = GdViewer1.PrintGetPaperWidth()
                
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            message = message + "    paper width: " + prnWidth.ToString() + vbCrLf
        Else
            message = "The PrintGetPaperWidth() method has failed with the status: " + GdViewer1.GetStat()
        End If
    End If
    If GdViewer1.GetStat() <> GdPictureStatus.OK Then
        message = "The example has NOT been followed successfully. Status: " + GdViewer1.GetStat().ToString()
    End If
    MessageBox.Show(message, "GdViewer.PrintGetPaperBin")
    //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)
    {
        float leftMargin = 0, rightMargin = 0;
        GdViewer1.PrintGetMargins(ref leftMargin, ref rightMargin);
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
            message = message + "    margins: left = " + leftMargin.ToString() + ", right = " + rightMargin.ToString() + "\n";
        else
            message = "The PrintGetMargins() method has failed with the status: " + GdViewer1.GetStat();
    }
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
    {
        int prnBin = GdViewer1.PrintGetPaperBin();
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
            message = message + "    paper bin: " + prnBin.ToString() + "\n";
        else
            message = "The PrintGetPaperBin() method has failed with the status: " + GdViewer1.GetStat();
    }
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
    {
        int prnSize = GdViewer1.PrintGetPaperSize();
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
            message = message + "    paper size: " + prnSize.ToString() + "\n";
        else
            message = "The PrintGetPaperSize() method has failed with the status: " + GdViewer1.GetStat();
    }
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
    {
        float prnHeight = GdViewer1.PrintGetPaperHeight();
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
            message = message + "    paper height: " + prnHeight.ToString();
        else
            message = "The PrintGetPaperHeight() method has failed with the status: " + GdViewer1.GetStat();
    }
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
    {
        float prnWidth = GdViewer1.PrintGetPaperWidth();
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
            message = message + "    paper width: " + prnWidth.ToString() + "\n";
        else
            message = "The PrintGetPaperWidth() method has failed with the status: " + GdViewer1.GetStat();
    }
    if (GdViewer1.GetStat() != GdPictureStatus.OK)
    {
        message = "The example has NOT been followed successfully. Status: " + GdViewer1.GetStat().ToString();
    }
    MessageBox.Show(message, "GdViewer.PrintGetPaperBin");
    See Also