PageSettings Class

 

Specifies settings that apply to a single, printed page.

Namespace:   System.Drawing.Printing
Assembly:  System.Drawing (in System.Drawing.dll)

System.Object
  System.Drawing.Printing.PageSettings

[SerializableAttribute]
public class PageSettings : ICloneable

NameDescription
System_CAPS_pubmethodPageSettings()

Initializes a new instance of the PageSettings class using the default printer.

System_CAPS_pubmethodPageSettings(PrinterSettings)

Initializes a new instance of the PageSettings class using a specified printer.

NameDescription
System_CAPS_pubpropertyBounds

Gets the size of the page, taking into account the page orientation specified by the Landscape property.

System_CAPS_pubpropertyColor

Gets or sets a value indicating whether the page should be printed in color.

System_CAPS_pubpropertyHardMarginX

Gets the x-coordinate, in hundredths of an inch, of the hard margin at the left of the page.

System_CAPS_pubpropertyHardMarginY

Gets the y-coordinate, in hundredths of an inch, of the hard margin at the top of the page.

System_CAPS_pubpropertyLandscape

Gets or sets a value indicating whether the page is printed in landscape or portrait orientation.

System_CAPS_pubpropertyMargins

Gets or sets the margins for this page.

System_CAPS_pubpropertyPaperSize

Gets or sets the paper size for the page.

System_CAPS_pubpropertyPaperSource

Gets or sets the page's paper source; for example, the printer's upper tray.

System_CAPS_pubpropertyPrintableArea

Gets the bounds of the printable area of the page for the printer.

System_CAPS_pubpropertyPrinterResolution

Gets or sets the printer resolution for the page.

System_CAPS_pubpropertyPrinterSettings

Gets or sets the printer settings associated with the page.

NameDescription
System_CAPS_pubmethodClone()

Creates a copy of this PageSettings.

System_CAPS_pubmethodCopyToHdevmode(IntPtr)

Copies the relevant information from the PageSettings to the specified DEVMODE structure.

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetType()

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

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodSetHdevmode(IntPtr)

Copies relevant information to the PageSettings from the specified DEVMODE structure.

System_CAPS_pubmethodToString()

This API supports the product infrastructure and is not intended to be used directly from your code. Converts the PageSettings to string form.(Overrides Object.ToString().)

The PageSettings class is used to specify settings that modify the way a page will be printed. Typically, you set default settings for all pages to be printed through the PrintDocument.DefaultPageSettings property. To specify settings on a page-by-page basis, handle the PrintDocument.PrintPage or PrintDocument.QueryPageSettings event and modify the PageSettings argument included in the PrintPageEventArgs or QueryPageSettingsEventArgs, respectively.

For more information about handling PrintDocument events, see the PrintDocument class overview. For more information about printing, see the System.Drawing.Printing namespace overview.

The following example demonstrates handling the PrintPage event and checking the PageSettings argument of PrintPageEventArgs. To use this code, add a PrintDocument component named PrintDocument1 to a Windows Form and associate its PrintPage event with the printDocument1_PrintPage method in the example.

private void printDocument1_PrintPage(object sender, System.Drawing.Printing.PrintPageEventArgs e)
{
    if (e.PageSettings.Color && !printDocument1.PrinterSettings.SupportsColor)
        MessageBox.Show("Color printing not supported on selected printer.", "Printer Warning", MessageBoxButtons.OKCancel);
}

.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: