PaperSource Class

.NET Framework (current version)

Other Versions

Specifies the paper tray from which the printer gets paper.

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

Inheritance Hierarchy

System::Object
System.Drawing.Printing::PaperSource

Syntax

C++

[SerializableAttribute]
public ref class PaperSource

Constructors

	Name	Description
	PaperSource()	Initializes a new instance of the PaperSource class.

Properties

	Name	Description
	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

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(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()	This API supports the product infrastructure and is not intended to be used directly from your code. Provides information about the PaperSource in string form.(Overrides Object::ToString().)

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.

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.

C++

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

Version Information

.NET Framework
Available since 1.1

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.