3 out of 16 rated this helpful - Rate this topic

PrintDialog Class

Lets users select a printer and choose which sections of the document to print from a Windows Forms application.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.CommonDialog
        System.Windows.Forms.PrintDialog

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public sealed class PrintDialog : CommonDialog

The PrintDialog type exposes the following members.

  Name Description
Public method PrintDialog Initializes a new instance of the PrintDialog class.
Top
  Name Description
Public property AllowCurrentPage Gets or sets a value indicating whether the Current Page option button is displayed.
Public property AllowPrintToFile Gets or sets a value indicating whether the Print to file check box is enabled.
Public property AllowSelection Gets or sets a value indicating whether the Selection option button is enabled.
Public property AllowSomePages Gets or sets a value indicating whether the Pages option button is enabled.
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public property Document Gets or sets a value indicating the PrintDocument used to obtain PrinterSettings.
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property PrinterSettings Gets or sets the printer settings the dialog box modifies.
Public property PrintToFile Gets or sets a value indicating whether the Print to file check box is selected.
Public property ShowHelp Gets or sets a value indicating whether the Help button is displayed.
Public property ShowNetwork Gets or sets a value indicating whether the Network button is displayed.
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property Tag Gets or sets an object that contains data about the control. (Inherited from CommonDialog.)
Public property UseEXDialog Gets or sets a value indicating whether the dialog should be shown in the Windows XP style for systems running Windows XP Home Edition, Windows XP Professional, Windows Server 2003 or later.
Top
  Name Description
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method HookProc Defines the common dialog box hook procedure that is overridden to add specific functionality to a common dialog box. (Inherited from CommonDialog.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OnHelpRequest Raises the HelpRequest event. (Inherited from CommonDialog.)
Protected method OwnerWndProc Defines the owner window procedure that is overridden to add specific functionality to a common dialog box. (Inherited from CommonDialog.)
Public method Reset Resets all options, the last selected printer, and the page settings to their default values. (Overrides CommonDialog.Reset().)
Protected method RunDialog When overridden in a derived class, specifies a common dialog box. (Inherited from CommonDialog.)
Public method ShowDialog() Runs a common dialog box with a default owner. (Inherited from CommonDialog.)
Public method ShowDialog(IWin32Window) Runs a common dialog box with the specified owner. (Inherited from CommonDialog.)
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Top
  Name Description
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public event HelpRequest Occurs when the user clicks the Help button on a common dialog box. (Inherited from CommonDialog.)
Top

When you create an instance of PrintDialog, the read/write properties are set to initial values. For a list of these values, see the PrintDialog constructor. To get printer settings that are modified by the user with the PrintDialog, use the PrinterSettings property.

For more information about printing with Windows Forms, see the System.Drawing.Printing namespace overview. If you want to print from a Windows Presentation Foundation application, see the System.Printing namespace.

The following code example demonstrates how to use the PrintDialog control to set the AllowSomePages, ShowHelp, and Document properties. To run this example, paste the following code into a form that contains a PrintDialog control named PrintDialog1 and a button named Button1. This example requires that the button's Click event and the PrintPage event of docToPrint have been connected to the event-handling methods defined in this example.



	// Declare the PrintDocument object.
	private System.Drawing.Printing.PrintDocument docToPrint = 
		new System.Drawing.Printing.PrintDocument();

	// This method will set properties on the PrintDialog object and
	// then display the dialog.
	private void Button1_Click(System.Object sender, 
		System.EventArgs e)
	{

		// Allow the user to choose the page range he or she would
		// like to print.
		PrintDialog1.AllowSomePages = true;

		// Show the help button.
		PrintDialog1.ShowHelp = true;

		// Set the Document property to the PrintDocument for 
		// which the PrintPage Event has been handled. To display the
		// dialog, either this property or the PrinterSettings property 
		// must be set 
		PrintDialog1.Document = docToPrint;

		DialogResult result = PrintDialog1.ShowDialog();

		// If the result is OK then print the document.
		if (result==DialogResult.OK)
		{
			docToPrint.Print();
		}

	}

	// The PrintDialog will print the document
	// by handling the document's PrintPage event.
	private void document_PrintPage(object sender, 
		System.Drawing.Printing.PrintPageEventArgs e)
	{

		// Insert code to render the page here.
		// This code will be called when the control is drawn.

		// The following code will render a simple
		// message on the printed document.
		string text = "In document_PrintPage method.";
		System.Drawing.Font printFont = new System.Drawing.Font
			("Arial", 35, System.Drawing.FontStyle.Regular);

		// Draw the content.
		e.Graphics.DrawString(text, printFont, 
			System.Drawing.Brushes.Black, 10, 10);
	}



of the PrintDialog control.

To run this example paste the following code must be placed in a form
containing a PrintDialog control named PrintDialog1 and a button named
Button1.


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
The code example neglects to mention the UseEXDialog property
On 64bit architectures the print dialog will not show unless you set this property to true before calling ShowDialog()