Stapling Enumeration
Specifies whether, and where, a printer staples a multi-page document.
Assembly: ReachFramework (in ReachFramework.dll)
| Member name | Description | |
|---|---|---|
| Unknown | The feature (whose options are represented by this enumeration) is set to an option not defined in the Print Schema. | |
| SaddleStitch | Multiple staples along the fold line. Also called saddle-stitch stapling. | |
| StapleBottomLeft | A single staple in the lower-left corner. | |
| StapleBottomRight | A single staple in the lower-right corner. | |
| StapleDualLeft | Two staples along the left edge. | |
| StapleDualRight | Two staples along the right edge. | |
| StapleDualTop | Two staples along the upper edge. | |
| StapleDualBottom | Two staples along the lower edge. | |
| StapleTopLeft | A single staple in the upper-left corner. | |
| StapleTopRight | A single staple in the upper-right corner. | |
| None | The document is not stapled. |
Use the values of this type primarily for these purposes:
-
As members of the StaplingCapability collection, which is a property of PrintCapabilities, these values indicate the types of stapling that a printer supports.
-
As the value of the Stapling property of a PrintTicket, the value instructs the printer whether, and where, to staple.
The Unknown value is never used in properties of PrintCapabilities objects.
You should never set a PrintTicket property to Unknown. If some other PrintTicket producing application has created a PrintTicket document that sets the stapling feature to an unrecognized option (that is, an option that is not defined in the Print Schema), then a PrintTicket object in your application that is constructed with that document will have Unknown as the value of the Stapling property.
Although the PrintTicket and PrintCapabilities classes cannot be inherited, you can extend the Print Schema to recognize print device features that are not accounted for in the PrintTicket or PrintCapabilities classes. For more information see How to: Extend the Print Schema and Create New Print System Classes.
The following example shows how to test a printer's capabilities and configure the print job to take advantage of them.
// ---------------------- GetPrintTicketFromPrinter ----------------------- /// <summary> /// Returns a PrintTicket based on the current default printer.</summary> /// <returns> /// A PrintTicket for the current local default printer.</returns> private PrintTicket GetPrintTicketFromPrinter() { PrintQueue printQueue = null; LocalPrintServer localPrintServer = new LocalPrintServer(); // Retrieving collection of local printer on user machine PrintQueueCollection localPrinterCollection = localPrintServer.GetPrintQueues(); System.Collections.IEnumerator localPrinterEnumerator = localPrinterCollection.GetEnumerator(); if (localPrinterEnumerator.MoveNext()) { // Get PrintQueue from first available printer printQueue = (PrintQueue)localPrinterEnumerator.Current; } else { // No printer exist, return null PrintTicket return null; } // Get default PrintTicket from printer PrintTicket printTicket = printQueue.DefaultPrintTicket; PrintCapabilities printCapabilites = printQueue.GetPrintCapabilities(); // Modify PrintTicket if (printCapabilites.CollationCapability.Contains(Collation.Collated)) { printTicket.Collation = Collation.Collated; } if ( printCapabilites.DuplexingCapability.Contains( Duplexing.TwoSidedLongEdge) ) { printTicket.Duplexing = Duplexing.TwoSidedLongEdge; } if (printCapabilites.StaplingCapability.Contains(Stapling.StapleDualLeft)) { printTicket.Stapling = Stapling.StapleDualLeft; } return printTicket; }// end:GetPrintTicketFromPrinter()
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
