PrintShowPrinterSettingsDialog(IntPtr) Method

In This Topic

Prompts the printer driver to show the printer settings dialog box of the active printer allowing you to specify a parent window handle.

Syntax

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

'Declaration
 
Public Overloads Function PrintShowPrinterSettingsDialog( _
   ByVal HANDLE As IntPtr _
) As GdPictureStatus

public GdPictureStatus PrintShowPrinterSettingsDialog( 
   IntPtr HANDLE
)

public function PrintShowPrinterSettingsDialog( 
    HANDLE: IntPtr
): GdPictureStatus;

public function PrintShowPrinterSettingsDialog( 
   HANDLE : IntPtr
) : GdPictureStatus;

public: GdPictureStatus PrintShowPrinterSettingsDialog( 
   IntPtr HANDLE
)

public:
GdPictureStatus PrintShowPrinterSettingsDialog( 
   IntPtr HANDLE
)

Parameters

HANDLE: A handle to the parent window of the active printer configuration property sheet.

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 display the printer's standard settings dialog box.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
    If GdViewer1.PrintShowPrinterSettingsDialog(Me.Handle) = GdPictureStatus.OK Then
        If GdViewer1.Print() = GdPictureStatus.OK Then
            'Displaying the printer settings dialog box.
            MessageBox.Show("The file has been printed successfully.", "GdViewer.PrintShowPrinterSettingsDialog")
        Else
            Dim message As String = "The file can't be printed." + vbCrLf + "Status: " + GdViewer1.GetStat().ToString()
            If GdViewer1.PrintGetStat() = GdPictureStatus.PrintingException Then message = message + "    Error: " + GdViewer1.PrintGetLastError()
            MessageBox.Show(message, "GdViewer.PrintShowPrinterSettingsDialog")
        End If
    End If
    GdViewer1.CloseDocument()
Else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.PrintShowPrinterSettingsDialog")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    //Displaying the printer settings dialog box.
    if (GdViewer1.PrintShowPrinterSettingsDialog(this.Handle) == GdPictureStatus.OK)
    {
        if (GdViewer1.Print() == GdPictureStatus.OK)
        {
            MessageBox.Show("The file has been printed successfully.", "GdViewer.PrintShowPrinterSettingsDialog");
        }
        else
        {
            string message = "The file can't be printed.\nStatus: " + GdViewer1.GetStat().ToString();
            if (GdViewer1.PrintGetStat() == GdPictureStatus.PrintingException)
                message = message + "    Error: " + GdViewer1.PrintGetLastError();
            MessageBox.Show(message, "GdViewer.PrintShowPrinterSettingsDialog");
        }
    }
    GdViewer1.CloseDocument();
}
else
{
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.PrintShowPrinterSettingsDialog");
}

Reference

GdViewer Class
GdViewer Members
Overload List
PrintGetStat Method
Print Method
PrintDialog Method
PrintGetActivePrinter Method
PrintSetActivePrinter Method