This documentation is archived and is not being maintained.

PrintDialog Class

Invokes a standard Microsoft Windows print dialog box that configures a PrintTicket and PrintQueue according to user input and then prints a document.


Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)

public class PrintDialog
<PrintDialog .../>

The PrintDialog type exposes the following members.

Public methodPrintDialogInitializes a new instance of the PrintDialog class.

Public propertyMaxPageGets or sets the highest page number that is allowed in page ranges.
Public propertyMinPageGets or sets the lowest page number that is allowed in page ranges.
Public propertyPageRangeGets or sets the range of pages to print when PageRangeSelection is set to UserPages.
Public propertyPageRangeSelectionGets or sets the PageRangeSelection for this instance of PrintDialog.
Public propertyPrintableAreaHeightGets the height of the printable area of the page.
Public propertyPrintableAreaWidthGets the width of the printable area of the page.
Public propertyPrintQueueGets or sets a PrintQueue that represents the printer that is selected.
Public propertyPrintTicketGets or sets the PrintTicket that is used by the PrintDialog when the user clicks Print for the current print job.
Public propertyUserPageRangeEnabledGets or sets a value that indicates whether users of the Print dialog box have the option to specify ranges of pages to print.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPrintDocumentPrints a DocumentPaginator object to the PrintQueue that is currently selected.
Public methodPrintVisualPrints a visual (non-text) object, which is derived from the Visual class, to the PrintQueue that is currently selected.
Public methodShowDialogInvokes the PrintDialog as a modal dialog box.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

A user can use the Print dialog box to select a printer, configure it, and perform a print job.

Strictly speaking, you can use the PrintDocument method without ever opening the dialog. In that sense, the control can be used as an unseen printing component. But for performance reasons, it would be better to use either the AddJob method or one of the many Write and WriteAsync methods of the XpsDocumentWriter. For more about this, see How to: Programmatically Print XPS Files.

Do not confuse this class, System.Windows.Controls.PrintDialog, with System.Windows.Forms.PrintDialog. The latter is used with Windows Forms applications. System.Windows.Controls.PrintDialog is used with Windows Presentation Foundation (WPF) applications. 

The following example shows how to create an instance of and display a simple PrintDialog by using Extensible Application Markup Language (XAML) markup and code.

<Button Width="200" Click="InvokePrint">Invoke PrintDialog</Button>


private void InvokePrint(object sender, RoutedEventArgs e)
        // Create the print dialog object and set options
        PrintDialog pDialog = new PrintDialog();
        pDialog.PageRangeSelection = PageRangeSelection.AllPages;
        pDialog.UserPageRangeEnabled = true;

        // Display the dialog. This returns true if the user presses the Print button.
        Nullable<Boolean> print = pDialog.ShowDialog();
        if (print == true)
            XpsDocument xpsDocument = new XpsDocument("C:\\FixedDocumentSequence.xps", FileAccess.ReadWrite);
            FixedDocumentSequence fixedDocSeq = xpsDocument.GetFixedDocumentSequence();
            pDialog.PrintDocument(fixedDocSeq.DocumentPaginator, "Test print job");

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.