PaperSize.PaperName Property

Definition

Namespace:

System.Drawing.Printing

Assembly:

System.Drawing.Common.dll

Source:

PaperSize.cs

Gets or sets the name of the type of paper.

public:
 property System::String ^ PaperName { System::String ^ get(); void set(System::String ^ value); };

public string PaperName { get; set; }

member this.PaperName : string with get, set

Public Property PaperName As String

Property Value

String

The name of the type of paper.

Exceptions

ArgumentException

The Kind property is not set to Custom.

Examples

The following code example populates the comboPaperSize combo box with the printer's supported paper sizes. 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

You can set the paper name only if the Kind property is set to Custom.

See also

• PaperKind