Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

PageSetupDialog Class

Enables users to change page-related print settings, including margins and paper orientation. This class cannot be inherited.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public sealed class PageSetupDialog : CommonDialog
public final class PageSetupDialog extends CommonDialog
public final class PageSetupDialog extends CommonDialog
Not applicable.

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.
private void Button1_Click(System.Object sender, System.EventArgs e)
{

    // Initialize the dialog's PrinterSettings property to hold user
    // defined printer settings.
    PageSetupDialog1.PageSettings =
        new System.Drawing.Printing.PageSettings();

    // Initialize dialog's PrinterSettings property to hold user
    // set printer settings.
    PageSetupDialog1.PrinterSettings =
        new System.Drawing.Printing.PrinterSettings();

    //Do not show the network in the printer dialog.
    PageSetupDialog1.ShowNetwork = false;

    //Show the dialog storing the result.
    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)
    {
        object[] results = new object[]{ 
            PageSetupDialog1.PageSettings.Margins, 
            PageSetupDialog1.PageSettings.PaperSize, 
            PageSetupDialog1.PageSettings.Landscape, 
            PageSetupDialog1.PrinterSettings.PrinterName, 
            PageSetupDialog1.PrinterSettings.PrintRange};
        ListBox1.Items.AddRange(results);
    }
   
}

//This method displays a PageSetupDialog object. If the
// user clicks OK in the dialog, selected results of
// the dialog are displayed in ListBox1.
private void button1_Click(System.Object sender, System.EventArgs e)
{
    // Initialize the dialog's PrinterSettings property to hold user
    // defined printer settings.
    pageSetupDialog1.set_PageSettings(
        new System.Drawing.Printing.PageSettings());
    // Initialize dialog's PrinterSettings property to hold user
    // set printer settings.
    pageSetupDialog1.set_PrinterSettings(
        new System.Drawing.Printing.PrinterSettings());
    //Do not show the network in the printer dialog.
    pageSetupDialog1.set_ShowNetwork(false);
    //Show the dialog storing the result.
    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.Equals(get_DialogResult().OK)) {
        Object results[] = new Object[] {
            pageSetupDialog1.get_PageSettings().get_Margins(),
            pageSetupDialog1.get_PageSettings().get_PaperSize(),
            ((System.Boolean)pageSetupDialog1.get_PageSettings().
            get_Landscape()),
            pageSetupDialog1.get_PrinterSettings().get_PrinterName(),
            pageSetupDialog1.get_PrinterSettings().get_PrintRange()};
        listBox1.get_Items().AddRange(results);
    }

} //button1_Click

System.Object
   System.MarshalByRefObject
     System.ComponentModel.Component
       System.Windows.Forms.CommonDialog
        System.Windows.Forms.PageSetupDialog
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.