PrintDialog(IWin32Window) 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 currently loaded PDF document. Using this method you can specify the top-level window that will own the modal dialog box.

Syntax

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

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

public bool PrintDialog( 
   IWin32Window owner
)

public function PrintDialog( 
    owner: IWin32Window
): Boolean;

public function PrintDialog( 
   owner : IWin32Window
) : boolean;

public: bool PrintDialog( 
   IWin32Window* owner
)

public:
bool PrintDialog( 
   IWin32Window^ owner
)

Parameters

owner: Represents the top-level window that will own the modal dialog box.

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.

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

Just to inform you, that sometimes pages in the PDF document may have defined their internal rotation, which causes them to be unexpectedly rotated when printing. Then you need to use the NormalizePage method for each such page to remove that rotation. You can also use the GetPageRotation method to find out if the page should be rotated when printed.

Example

How to print the current document using the standard Windows Print dialog box.

VB.NET
C#

Dim caption As String = "Example: PrintDialog"
Using gdpicturePDF As New GdPicturePDF()
    If gdpicturePDF.LoadFromFile("document_to_print.pdf", False) = GdPictureStatus.OK Then
        If gdpicturePDF.PrintDialog(Me) = True Then
            MessageBox.Show("The file has been printed successfully.", caption)
        Else
            Dim message As String = "The file can't be printed." + vbCrLf + "Status: " + gdpicturePDF.PrintGetStat().ToString()
            If gdpicturePDF.PrintGetStat() = GdPictureStatus.PrintingException Then
                message = message + "    Error: " + gdpicturePDF.PrintGetLastError()
            End If
            MessageBox.Show(message, caption)
        End If
        gdpicturePDF.CloseDocument()
    Else
        MessageBox.Show("The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString(), caption)
    End If
End Using

string caption = "Example: PrintDialog";
using (GdPicturePDF gdpicturePDF = new GdPicturePDF())
{
    if (gdpicturePDF.LoadFromFile("document_to_print.pdf", false) == GdPictureStatus.OK)
    {
        if (gdpicturePDF.PrintDialog(this) == true)
        {
            MessageBox.Show("The file has been printed successfully.", caption);
        }
        else
        {
            string message = "The file can't be printed.\nStatus: " + gdpicturePDF.PrintGetStat().ToString();
            if (gdpicturePDF.PrintGetStat() == GdPictureStatus.PrintingException)
                message = message + "    Error: " + gdpicturePDF.PrintGetLastError();
            MessageBox.Show(message, caption);
        }
        gdpicturePDF.CloseDocument();
    }
    else
    {
        MessageBox.Show("The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString(), caption);
    }
}

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
PrintDialogFit Method
Print Method
PrintFit Method
PrintGetStat Method
PrintGetLastError Method
NormalizePage Method