PaperSource Class

Reference

Definition

Namespace:: System.Drawing.Printing

Assembly:: System.Drawing.Common.dll

Assembly:: System.Drawing.dll

Package:: System.Drawing.Common v6.0.0

Package:: System.Drawing.Common v7.0.0

Package:: System.Drawing.Common v8.0.0

Package:: System.Drawing.Common v9.0.0-preview.2.24128.3

Source:: PaperSource.cs

Source:: PaperSource.cs

Source:: PaperSource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies the paper tray from which the printer gets paper.

public ref class PaperSource

public class PaperSource

[System.Serializable]
public class PaperSource

type PaperSource = class

[<System.Serializable>]
type PaperSource = class

Public Class PaperSource

Inheritance: Object
PaperSource

Attributes: SerializableAttribute

Examples

The following code example populates the comboPaperSource combo box with the printer's supported paper sources. The SourceName is identified as the property that provides the display string for the item being added through the DisplayMember property of the combo box. The example requires that a PrintDocument variable named printDoc exists and that the specific combo box exists.

// Add list of paper sources found on the printer to the combo box.
// The DisplayMember property is used to identify the property that will provide the display String*.
comboPaperSource->DisplayMember = "SourceName";
PaperSource^ pkSource;
for ( int i = 0; i < printDoc->PrinterSettings->PaperSources->Count; i++ )
{
   pkSource = printDoc->PrinterSettings->PaperSources[ i ];
   comboPaperSource->Items->Add( pkSource );
}

// Add list of paper sources found on the printer to the combo box.
// The DisplayMember property is used to identify the property that will provide the display string.
comboPaperSource.DisplayMember="SourceName";

PaperSource pkSource;
for (int i = 0; i < printDoc.PrinterSettings.PaperSources.Count; i++){
    pkSource = printDoc.PrinterSettings.PaperSources[i];
    comboPaperSource.Items.Add(pkSource);
}

' Add list of paper sources found on the printer to the combo box.
' The DisplayMember property is used to identify the property that will provide the display string.
comboPaperSource.DisplayMember = "SourceName"

Dim pkSource As PaperSource
For i = 0 to printDoc.PrinterSettings.PaperSources.Count - 1
    pkSource = printDoc.PrinterSettings.PaperSources.Item(i)
    comboPaperSource.Items.Add(pkSource)
Next

Remarks

This class is used by PrinterSettings.PaperSources and PageSettings.PaperSource properties to get the paper source trays that are available on the printer and to set the paper source for a page, respectively.

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

Constructors

PaperSource()

Initializes a new instance of the PaperSource class.

Properties

Kind	Gets the paper source.
RawKind	Gets or sets the integer representing one of the PaperSourceKind values or a custom value.
SourceName	Gets or sets the name of the paper source.

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 PaperSource in string form.

Applies to