Export (0) Print
Expand All

PrintTicket Class

Defines the settings of a print job.

System.Object
  System.Printing.PrintTicket

Namespace:  System.Printing
Assembly:  ReachFramework (in ReachFramework.dll)
XMLNS for XAML: Not mapped to an xmlns.

'Declaration
Public NotInheritable Class PrintTicket _
	Implements INotifyPropertyChanged
<PrintTicket .../>

The PrintTicket type exposes the following members.

  NameDescription
Public methodPrintTicketInitializes a new instance of the PrintTicket class.
Public methodPrintTicket(Stream)Initializes a new instance of the PrintTicket class by using an XML stream (that contains a PrintTicket document) that complies with the XML Print Schema.
Top

  NameDescription
Public propertyCollationGets or sets a value indicating whether the printer collates its output.
Public propertyCopyCountGets or sets the number of copies for the print job.
Public propertyDeviceFontSubstitutionGets or sets a value indicating whether the printer substitutes device-based fonts for computer-based fonts on the print job.
Public propertyDuplexingGets or sets a value indicating what kind of two-sided printing, if any, the printer uses for the print job.
Public propertyInputBinGets or sets a value indicating what input bin (paper tray) to use.
Public propertyOutputColorGets or sets a value indicating how the printer handles content that has color or shades of gray.
Public propertyOutputQualityGets or sets a value indicating the quality of output for the print job.
Public propertyPageBorderlessGets or sets a value indicating whether the device prints content to the edge of the media or leaves an unprinted margin around the edge.
Public propertyPageMediaSizeGets or sets the page size for the paper (or other media) that a printer uses for a print job.
Public propertyPageMediaTypeGets or sets a value indicating what sort of paper or media the printer uses for the print job.
Public propertyPageOrderGets or sets a value indicating whether the printer prints multiple pages back-to-front or front-to-back.
Public propertyPageOrientationGets or sets a value indicating how the page content is oriented for printing.
Public propertyPageResolutionGets or sets the level of page resolution that the printer uses for a print job.
Public propertyPageScalingFactorGets or sets the percentage by which the printer enlarges or reduces the print image on a page.
Public propertyPagesPerSheetGets or sets the number of pages that print on each printed side of a sheet of paper.
Public propertyPagesPerSheetDirectionGets or sets a value indicating how a printer arranges multiple pages that print on each side of a sheet of paper.
Public propertyPhotoPrintingIntentGets or sets a value indicating in qualitative terms the level of quality the printer uses to print a photograph.
Public propertyStaplingGets or sets a value indicating whether, and where, a printer staples multiple pages.
Public propertyTrueTypeFontModeGets or sets a value indicating how the printer handles text that uses TrueType fonts.
Top

  NameDescription
Public methodCloneCreates a modifiable clone of this PrintTicket, making deep copies of this object's values.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetXmlStreamReturns a MemoryStream object that represents the property values of a PrintTicket as an XML stream that conforms to the Print Schema.
Public methodSaveToSaves the PrintTicket settings to a Stream object by using an XML format that conforms to the Print Schema.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventPropertyChangedOccurs when any property of the PrintTicket changes.
Top

A PrintTicket object is an easy-to-work-with representation of a certain type of XML document called a PrintTicket document. The latter is a set of instructions telling a printer how to set its various features (such as duplexing, collating, and stapling). For example, to instruct the printer to turn on its stapler and staple print jobs in the upper left corner, the document would have a <JobStapleAllDocuments … > element that specifies StapleTopLeft. The element is, in turn, represented by the Stapling property of the PrintTicket object. The PrintTicket document must conform to the Print Schema.

The PrintTicket class enables your application to configure the printer's features without having to engage in any direct writing of XML Stream objects.

All of the most popular features of home and business file and photo printers are represented by properties of PrintTicket the class. But the Print Schema defines many more, less common, features and it can be extended to handle features of specialty printing devices. So, 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.

Note   When the PrintTicket object is created with the constructor that takes a PrintTicket document (as a Stream) parameter, that entire document is stored in a non-public field in the object, including the XML elements within it that express less common features that are not represented by any of the public properties of the PrintTicket class. In fact, if the driver that produced the PrintTicket document is using a private extension of the Print Schema, that privately defined markup is also stored as part of the non-public PrintTicket document.

Caution noteCaution

Classes within the System.Printing namespace are not supported for use within a Windows service or ASP.NET application or service. Attempting to use these classes from within one of these application types may produce unexpected problems, such as diminished service performance and run-time exceptions.

If you want to print from a Windows Forms application, see the System.Drawing.Printing namespace.

The following example shows how to determine the capabilities of a specific printer and how to configure a 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 Function GetPrintTicketFromPrinter() As PrintTicket
    Dim printQueue As PrintQueue = Nothing

    Dim localPrintServer As New LocalPrintServer()

    ' Retrieving collection of local printer on user machine
    Dim localPrinterCollection As PrintQueueCollection = localPrintServer.GetPrintQueues()

    Dim localPrinterEnumerator As System.Collections.IEnumerator = localPrinterCollection.GetEnumerator()

    If localPrinterEnumerator.MoveNext() Then
        ' Get PrintQueue from first available printer
        printQueue = CType(localPrinterEnumerator.Current, PrintQueue)
    Else
        ' No printer exist, return null PrintTicket
        Return Nothing
    End If

    ' Get default PrintTicket from printer
    Dim printTicket As PrintTicket = printQueue.DefaultPrintTicket

    Dim printCapabilites As PrintCapabilities = printQueue.GetPrintCapabilities()

    ' Modify PrintTicket
    If printCapabilites.CollationCapability.Contains(Collation.Collated) Then
        printTicket.Collation = Collation.Collated
    End If

    If printCapabilites.DuplexingCapability.Contains(Duplexing.TwoSidedLongEdge) Then
        printTicket.Duplexing = Duplexing.TwoSidedLongEdge
    End If

    If printCapabilites.StaplingCapability.Contains(Stapling.StapleDualLeft) Then
        printTicket.Stapling = Stapling.StapleDualLeft
    End If

    Return printTicket
End Function ' end:GetPrintTicketFromPrinter()

.NET Framework

Supported in: 4.5, 4, 3.5, 3.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