PrintDialog Class
Lets users select a printer and choose which sections of the document to print from a Windows Forms application.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
System::MarshalByRefObject
System.ComponentModel::Component
System.Windows.Forms::CommonDialog
System.Windows.Forms::PrintDialog
| Name | Description | |
|---|---|---|
![]() | PrintDialog() | Initializes a new instance of the PrintDialog class. |
| Name | Description | |
|---|---|---|
![]() | AllowCurrentPage | Gets or sets a value indicating whether the Current Page option button is displayed. |
![]() | AllowPrintToFile | Gets or sets a value indicating whether the Print to file check box is enabled. |
![]() | AllowSelection | Gets or sets a value indicating whether the Selection option button is enabled. |
![]() | AllowSomePages | Gets or sets a value indicating whether the Pages option button is enabled. |
![]() | Container | Gets the IContainer that contains the Component.(Inherited from Component.) |
![]() | Document | Gets or sets a value indicating the PrintDocument used to obtain PrinterSettings. |
![]() | PrinterSettings | Gets or sets the printer settings the dialog box modifies. |
![]() | PrintToFile | Gets or sets a value indicating whether the Print to file check box is selected. |
![]() | ShowHelp | Gets or sets a value indicating whether the Help button is displayed. |
![]() | ShowNetwork | Gets or sets a value indicating whether the Network button is displayed. |
![]() | Site | |
![]() | Tag | Gets or sets an object that contains data about the control. (Inherited from CommonDialog.) |
![]() | 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. |
| Name | Description | |
|---|---|---|
![]() | CreateObjRef(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.) |
![]() | Dispose() | |
![]() | Equals(Object^) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.) |
![]() | GetType() | |
![]() | InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.) |
![]() | Reset() | Resets all options, the last selected printer, and the page settings to their default values.(Overrides CommonDialog::Reset().) |
![]() | ShowDialog() | Runs a common dialog box with a default owner.(Inherited from CommonDialog.) |
![]() | ShowDialog(IWin32Window^) | Runs a common dialog box with the specified owner.(Inherited from CommonDialog.) |
![]() | ToString() |
| Name | Description | |
|---|---|---|
![]() | Disposed | |
![]() | HelpRequest | 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. System::Drawing::Printing::PrintDocument^ docToPrint; // This method will set properties on the PrintDialog object and // then display the dialog. 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; if ( docToPrint == nullptr ) System::Windows::Forms::MessageBox::Show( "null" ); ; ; if ( PrintDialog1 == nullptr ) System::Windows::Forms::MessageBox::Show( "pnull" ); ; ; System::Windows::Forms::DialogResult result = PrintDialog1->ShowDialog(); System::Windows::Forms::MessageBox::Show( result.ToString() ); ; ; // 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. 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 = gcnew System::Drawing::Font( "Arial",35,System::Drawing::FontStyle::Regular ); // Draw the content. e->Graphics->DrawString( text, printFont, System::Drawing::Brushes::Black, 10, 10 ); }
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.


