PaperSize Class

Definition

Namespace:

System.Drawing.Printing

Assembly:

System.Drawing.Common.dll

Source:

PaperSize.cs

Specifies the size of a piece of paper.

public ref class PaperSize

public class PaperSize

type PaperSize = class

Public Class PaperSize

Inheritance

Object

PaperSize

Examples

The following code example populates the comboPaperSize combo box with the printer's supported paper sizes. In addition, a custom paper size is created and added to the combo box. The PaperName is identified as the property that will provide the display string for the item being added through the DisplayMember property of the combo box. The example assumes that a PrintDocument variable named printDoc exists and that the specific combo box exists.

// Add list of supported paper sizes found on the printer.
// The DisplayMember property is used to identify the property that will provide the display String*.
comboPaperSize->DisplayMember = "PaperName";
PaperSize^ pkSize;
for ( int i = 0; i < printDoc->PrinterSettings->PaperSizes->Count; i++ )
{
   pkSize = printDoc->PrinterSettings->PaperSizes[ i ];
   comboPaperSize->Items->Add( pkSize );
}

// Create a PaperSize and specify the custom paper size through the constructor and add to combobox.
PaperSize^ pkCustomSize1 = gcnew PaperSize( "First custom size",100,200 );
comboPaperSize->Items->Add( pkCustomSize1 );

// Add list of supported paper sizes found on the printer. 
// The DisplayMember property is used to identify the property that will provide the display string.
comboPaperSize.DisplayMember = "PaperName";

PaperSize pkSize;
for (int i = 0; i < printDoc.PrinterSettings.PaperSizes.Count; i++){
    pkSize = printDoc.PrinterSettings.PaperSizes[i];
    comboPaperSize.Items.Add(pkSize);
}

// Create a PaperSize and specify the custom paper size through the constructor and add to combobox.
PaperSize pkCustomSize1 = new PaperSize("First custom size", 100, 200);

comboPaperSize.Items.Add(pkCustomSize1);

' Add list of supported paper sizes found on the printer. 
' The DisplayMember property is used to identify the property that will provide the display string.
comboPaperSize.DisplayMember = "PaperName"

Dim pkSize As PaperSize
For i = 0 to printDoc.PrinterSettings.PaperSizes.Count - 1
    pkSize = printDoc.PrinterSettings.PaperSizes.Item(i)
    comboPaperSize.Items.Add(pkSize)
Next

' Create a PaperSize and specify the custom paper size through the constructor and add to combobox.
Dim pkCustomSize1 As New PaperSize("Custom Paper Size", 100, 200)

comboPaperSize.Items.Add(pkCustomSize1)

Remarks

This class is used by the PrinterSettings.PaperSizes and PageSettings.PaperSize properties to get the paper sizes that are available on the printer and to set the paper size for a page, respectively.

You can use the PaperSize constructor to specify a custom paper size. The Width and Height property values can be set only for custom PaperSize objects.

For more information about printing, see the System.Drawing.Printing namespace overview.

Constructors

PaperSize()	Initializes a new instance of the PaperSize class.
PaperSize(String, Int32, Int32)	Initializes a new instance of the PaperSize class.

Properties

Height	Gets or sets the height of the paper, in hundredths of an inch.
Kind	Gets the type of paper.
PaperName	Gets or sets the name of the type of paper.
RawKind	Gets or sets an integer representing one of the PaperSize values or a custom value.
Width	Gets or sets the width of the paper, in hundredths of an inch.

Methods

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)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Provides information about the PaperSize in string form.

See also

• Kind
• PrinterSettings
• PaperSizes
• PaperSize
• DisplayMember