PrintDialog Class
TOC
Collapse the table of content
Expand the table of content

PrintDialog Class

 

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

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

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

public sealed class PrintDialog : CommonDialog

NameDescription
System_CAPS_pubmethodPrintDialog()

Initializes a new instance of the PrintDialog class.

NameDescription
System_CAPS_pubpropertyAllowCurrentPage

Gets or sets a value indicating whether the Current Page option button is displayed.

System_CAPS_pubpropertyAllowPrintToFile

Gets or sets a value indicating whether the Print to file check box is enabled.

System_CAPS_pubpropertyAllowSelection

Gets or sets a value indicating whether the Selection option button is enabled.

System_CAPS_pubpropertyAllowSomePages

Gets or sets a value indicating whether the Pages option button is enabled.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyDocument

Gets or sets a value indicating the PrintDocument used to obtain PrinterSettings.

System_CAPS_pubpropertyPrinterSettings

Gets or sets the printer settings the dialog box modifies.

System_CAPS_pubpropertyPrintToFile

Gets or sets a value indicating whether the Print to file check box is selected.

System_CAPS_pubpropertyShowHelp

Gets or sets a value indicating whether the Help button is displayed.

System_CAPS_pubpropertyShowNetwork

Gets or sets a value indicating whether the Network button is displayed.

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertyTag

Gets or sets an object that contains data about the control. (Inherited from CommonDialog.)

System_CAPS_pubpropertyUseEXDialog

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.

NameDescription
System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodReset()

Resets all options, the last selected printer, and the page settings to their default values.(Overrides CommonDialog.Reset().)

System_CAPS_pubmethodShowDialog()

Runs a common dialog box with a default owner.(Inherited from CommonDialog.)

System_CAPS_pubmethodShowDialog(IWin32Window)

Runs a common dialog box with the specified owner.(Inherited from CommonDialog.)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

System_CAPS_pubeventHelpRequest

Occurs when the user clicks the Help button on a common dialog box.(Inherited from CommonDialog.)

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);
}

.NET Framework
Available since 1.1

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

Return to top
Show:
© 2016 Microsoft