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

PageSetupDialog Class

Represents a dialog box that allows users to manipulate page settings, including margins and paper orientation.

For a list of all members of this type, see PageSetupDialog Members.

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

[Visual Basic]
NotInheritable Public Class PageSetupDialog
   Inherits CommonDialog
[C#]
public sealed class PageSetupDialog : CommonDialog
[C++]
public __gc __sealed class PageSetupDialog : public CommonDialog
[JScript]
public class PageSetupDialog extends CommonDialog

Thread Safety

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

Remarks

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, margins, and paper orientation, size, and source and to show help and network buttons. MinMargins defines the minimum margins a user can select.

When you create an instance of PageSetupDialog, the read/write properties are set to initial values. For a list of these values, see the PageSetupDialog constructor.

Example

[Visual Basic, C#] The following code example demonstrates the PageSetupDialog using the PageSettings, PrinterSettings, and ShowNetwork properties. This example assumes it is located 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.

[Visual Basic] 

    'This method displays a PageSetupDialog object. If the
    ' user clicks OK in the dialog, selected results of
    ' the dialog are displayed in ListBox1.
    Private Sub Button1_Click(ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button1.Click

        ' 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.
        Dim result As DialogResult = 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) Then
            Dim results() As Object = New Object() _
                {PageSetupDialog1.PageSettings.Margins, _
                 PageSetupDialog1.PageSettings.PaperSize, _
                 PageSetupDialog1.PageSettings.Landscape, _
                 PageSetupDialog1.PrinterSettings.PrinterName, _
                 PageSetupDialog1.PrinterSettings.PrintRange}
            ListBox1.Items.AddRange(results)
        End If
    End Sub

[C#] 

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

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Windows.Forms

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

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

See Also

PageSetupDialog Members | System.Windows.Forms Namespace | CommonDialog | Margins | PageSettings | PrintDocument | PrinterSettings

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.