PrintTool.PrintDialog(IWin32Window, UserLookAndFeel) Method

Runs the Print dialog to select a printer, specify the print options (number of copies, page range, and paper source) and print the document.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.XtraPrinting.v24.1.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.Printing

Declaration

C#

public bool? PrintDialog(
    IWin32Window owner,
    UserLookAndFeel lookAndFeel
)

VB.NET

Public Function PrintDialog(
    owner As IWin32Window,
    lookAndFeel As UserLookAndFeel
) As Boolean?

Parameters

Name	Type	Description
owner	IWin32Window	A IWin32Window object that is the parent window for this dialog.
lookAndFeel	UserLookAndFeel	A UserLookAndFeel object, specifying the look-and-feel settings applied to the Print dialog.

Returns

Type	Description
Nullable<Boolean>	true if the user clicks Print in the dialog box; false if the user clicks Cancel; otherwise null (Nothing in Visual Basic).

Remarks

The following image illustrates the Print dialog that is invoked by this method and replaces the standard PrintDialog.

If a document has not been created prior to calling the PrintDialog method, the PrintDialog internally calls the Link.CreateDocument method.

To obtain the document after it is generated, use the PrintingSystemBase.Document property of the PrintToolBase.PrintingSystem.

Note

Changing page settings in the Print Dialog does not recreate the current document and affects only the printing result.

Example

To make the PrintTool.PrintDialog method invoke the standard system Print dialog, add the following code to the application’s Program.cs unit (Program.vb in Visual Basic).

This will replace the DefaultPrintDialogRunner, returned by the PrintDialogRunner.Instance property, with a SystemPrintDialogRunner.

C#

using DevExpress.XtraPrinting.Preview;
// ...

static void Main(string[] args) {
    PrintDialogRunner.Instance = new SystemPrintDialogRunner();
    // ...
}

VB.NET

Imports DevExpress.XtraPrinting.Preview
' ...

Partial Friend Class MyApplication
    <Global.System.Diagnostics.DebuggerStepThroughAttribute()>  _
    Public Sub New()
        ' ...
        PrintDialogRunner.Instance = New SystemPrintDialogRunner()
    End Sub
' ...
End Class