Export (0) Print
Expand All

PaperSource Class

Specifies the paper tray from which the printer gets paper.

System.Object
  System.Drawing.Printing.PaperSource

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

[SerializableAttribute]
public class PaperSource

The PaperSource type exposes the following members.

  NameDescription
Public methodPaperSourceInitializes a new instance of the PaperSource class.
Top

  NameDescription
Public propertyKindGets the paper source.
Public propertyRawKindGets or sets the integer representing one of the PaperSourceKind values or a custom value.
Public propertySourceNameGets or sets the name of the paper source.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringInfrastructure. Provides information about the PaperSource in string form. (Overrides Object.ToString().)
Top

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.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft