PageSetupDialog Class
Enables users to change page-related print settings, including margins and paper orientation. This class cannot be inherited.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
System::MarshalByRefObject
System.ComponentModel::Component
System.Windows.Forms::CommonDialog
System.Windows.Forms::PageSetupDialog
| Name | Description | |
|---|---|---|
![]() | PageSetupDialog() | Initializes a new instance of the PageSetupDialog class. |
| Name | Description | |
|---|---|---|
![]() | AllowMargins | Gets or sets a value indicating whether the margins section of the dialog box is enabled. |
![]() | AllowOrientation | Gets or sets a value indicating whether the orientation section of the dialog box (landscape versus portrait) is enabled. |
![]() | AllowPaper | Gets or sets a value indicating whether the paper section of the dialog box (paper size and paper source) is enabled. |
![]() | AllowPrinter | Gets or sets a value indicating whether the Printer button is enabled. |
![]() | Container | Gets the IContainer that contains the Component.(Inherited from Component.) |
![]() | Document | Gets or sets a value indicating the PrintDocument to get page settings from. |
![]() | EnableMetric | Gets or sets a value indicating whether the margin settings, when displayed in millimeters, should be automatically converted to and from hundredths of an inch. |
![]() | MinMargins | Gets or sets a value indicating the minimum margins, in hundredths of an inch, the user is allowed to select. |
![]() | PageSettings | Gets or sets a value indicating the page settings to modify. |
![]() | PrinterSettings | Gets or sets the printer settings that are modified when the user clicks the Printer button in the dialog. |
![]() | ShowHelp | Gets or sets a value indicating whether the Help button is visible. |
![]() | ShowNetwork | Gets or sets a value indicating whether the Network button is visible. |
![]() | Site | |
![]() | Tag | Gets or sets an object that contains data about the control. (Inherited from CommonDialog.) |
| 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 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.) |
The PageSetupDialog dialog box modifies the PageSettings and PrinterSettings information for a given Document. The user can enable sections of the dialog box to manipulate printing and margins; paper orientation, size, and source; and to show Help and network buttons. The MinMargins property defines the minimum margins a user can select.
When you create an instance of the PageSetupDialog class, the read/write properties are set to initial values. For a list of these values, see the PageSetupDialog constructor.
Because a PageSetupDialog needs page settings to display, you need to set the Document, PrinterSettings, or PageSettings property before calling ShowDialog; otherwise, an exception will occur.
The following code example demonstrates the PageSetupDialog using the PageSettings, PrinterSettings, and ShowNetwork properties. To run this example, place it in a form containing a Button named Button1, a ListBox named ListBox1, and a PageSetupDialog named PageSetupDialog1. Ensure the button's click event is connected to the event-handling method in this example.
//This method displays a PageSetupDialog object. If the // user clicks OK in the dialog, selected results of // the dialog are displayed in ListBox1. void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ ) { // Initialize the dialog's PrinterSettings property to hold user // defined printer settings. PageSetupDialog1->PageSettings = gcnew System::Drawing::Printing::PageSettings; // Initialize dialog's PrinterSettings property to hold user // set printer settings. PageSetupDialog1->PrinterSettings = gcnew System::Drawing::Printing::PrinterSettings; //Do not show the network in the printer dialog. PageSetupDialog1->ShowNetwork = false; //Show the dialog storing the result. System::Windows::Forms::DialogResult result = PageSetupDialog1->ShowDialog(); // If the result is OK, display selected settings in // ListBox1. These values can be used when printing the // document. if ( result == ::DialogResult::OK ) { array<Object^>^results = {PageSetupDialog1->PageSettings->Margins,PageSetupDialog1->PageSettings->PaperSize,PageSetupDialog1->PageSettings->Landscape,PageSetupDialog1->PrinterSettings->PrinterName,PageSetupDialog1->PrinterSettings->PrintRange}; ListBox1->Items->AddRange( results ); } }
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.


