Print Method (GdViewer)

In This Topic

Prints the document currently displayed in the GdViewer control to the active printer allowing you to adjust the size of printed pages.

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 Function Print( _
   ByVal PrintSizeMode As PrintSizeOption _
) As GdPictureStatus

public GdPictureStatus Print( 
   PrintSizeOption PrintSizeMode
)

public function Print( 
    PrintSizeMode: PrintSizeOption
): GdPictureStatus;

public function Print( 
   PrintSizeMode : PrintSizeOption
) : GdPictureStatus;

public: GdPictureStatus Print( 
   PrintSizeOption PrintSizeMode
)

public:
GdPictureStatus Print( 
   PrintSizeOption PrintSizeMode
)

Parameters

PrintSizeMode: A member of the PrintSizeOption enumeration. Sets up the automatic scalling of a printed document to fit the current paper size.

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

Please note that you can use the PrintGetStat method to identify the specific reason for the printing failure.

Just to remind you that you can also utilize both the BeforePrintPage and the AfterPrintPage events 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 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.Print(PrintSizeOption.PrintSizeOptionFit) = GdPictureStatus.OK Then
        MessageBox.Show("The file has been printed successfully.", "GdViewer.Print")
    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.Print")
    End If
    GdViewer1.CloseDocument()
Else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.Print")
End If

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

Reference

GdViewer Class
GdViewer Members
PrintDialog(PrintSizeOption) Method
PrintGetStat Method
PrintGetLastError Method