PrintDialog(IWin32Window,PrintSizeOption) Method

In This Topic

Invokes the standard Windows Print dialog box, which allows you to select additional options or settings and then to print the document currently displayed in the GdViewer control. You can also adjust the size of printed pages according to your preference using this method for printing. At the same time, you can specify the top-level window that will own the modal dialog box.

During the print process, the BeforePrintPage and the AfterPrintPage events are raised just before and right after the single page is printed.

Syntax

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

'Declaration
 
Public Overloads Function PrintDialog( _
   ByVal owner As IWin32Window, _
   ByVal PrintSizeMode As PrintSizeOption _
) As Boolean

public bool PrintDialog( 
   IWin32Window owner,
   PrintSizeOption PrintSizeMode
)

public function PrintDialog( 
    owner: IWin32Window;
    PrintSizeMode: PrintSizeOption
): Boolean;

public function PrintDialog( 
   owner : IWin32Window,
   PrintSizeMode : PrintSizeOption
) : boolean;

public: bool PrintDialog( 
   IWin32Window* owner,
   PrintSizeOption PrintSizeMode
)

public:
bool PrintDialog( 
   IWin32Window^ owner,
   PrintSizeOption PrintSizeMode
)

Parameters

owner: Represents the top-level window that will own the modal dialog box.
PrintSizeMode: A member of the PrintSizeOption enumeration. Sets up the automatic scalling of a printed document to fit the current paper size.

Return Value

true if the method has been followed successfully, otherwise false. Please use the PrintGetStat method to determine the reason for the printing failure.

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 you can also utilize both the BeforePrintPage and the AfterPrintPage events during the print process using this method.

You also need to be aware that annotations and form fields included in the document are rendered by default using this method when printing.

Example

How to print the currently displayed document using the standard Windows Print dialog box so the document's pages are adjusted to the specified paper size automatically.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
    If GdViewer1.PrintDialog(Me, PrintSizeOption.PrintSizeOptionFit) = GdPictureStatus.OK Then
        MessageBox.Show("The file has been printed successfully.", "GdViewer.PrintDialog")
    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.PrintDialog")
    End If
    GdViewer1.CloseDocument()
Else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.PrintDialog")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    if (GdViewer1.PrintDialog(this, PrintSizeOption.PrintSizeOptionFit) == GdPictureStatus.OK)
    {
        MessageBox.Show("The file has been printed successfully.", "GdViewer.PrintDialog");
    }
    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.PrintDialog");
    }
    GdViewer1.CloseDocument();
}
else
{
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.PrintDialog");
}

Reference

GdViewer Class
GdViewer Members
Overload List
Print Method
PrintGetStat Method
PrintGetLastError Method