PrintTaskOptions class

Applies to Windows only

Represents a collection of methods and properties for managing the options which define how the content is to be printed.

Syntax


/* For information about creating or accessing this object, see Remarks. */

Attributes

[MarshalingBehavior(Agile)]
[Muse()]
[Version(0x06020000)]

Members

The PrintTaskOptions class has these types of members:

Methods

The PrintTaskOptions class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
GetPageDescription Retrieves the physical dimensions of the printed page.

 

Properties

The PrintTaskOptions class has these properties.

PropertyAccess typeDescription

Binding

Read/writeGets or sets the binding option for the print task.

Collation

Read/writeGets or sets the collation option of the print tasks.

ColorMode

Read/writeGets or sets the color mode option of the print task.

DisplayedOptions

Read-onlyGets the list of options displayed for the print experience.

Duplex

Read/writeGets or sets the duplex option of the print task.

HolePunch

Read/writeGets or sets the hole punch option of the print task.

MaxCopies

Read-onlyGets the maximum number of copies supported for the print task.

MediaSize

Read/writeGets or sets the media size option of the print task.

MediaType

Read/writeGets or sets the media type option for the print task.

MinCopies

Read-onlyGets the minimum number of copies allowed for the print task.

NumberOfCopies

Read/writeGets or sets the value for the number of copies for the print task.

Orientation

Read/writeGets or sets the orientation option for the print task.

PrintQuality

Read/writeGets or sets the print quality option for the print task.

Staple

Read/writeGets or sets the staple option for the print task.

 

Remarks

The PrintTaskOptions class provides access to the different values that define how the content in the print task is to be formatted during printing. The PrintTaskOptions object may contain information like the size of the printed page, its orientation, and the type of media on which the content will be printed. In addition the PrintTaskOptions object provides access to the list of options to be displayed in the print window.

While each option in PrintTaskOptions, for example MediaSize or MediaType, has a specific set of supported values all the options support the same general pattern for representing some common cases. The common case values are Default, NotAvailable and PrinterCustom.

Each option contains a default value, and it is the value that is assigned to the option by the print target. When this value is retrieved via a property access, it is an indication that the print target has not yet determined the actual value for this option. When you set the default value for a particular option, it indicates to the print target that it must use the default value that it has for that option. If there is no default value for that option, then the option value is unchanged.

An option may also report a NotAvailable value. This indicates that the specific option is not available for the currently selected print target. For example, if the Duplex property returns a NotAvailable value, it indicates that the print target does not support duplex functionality. It is not possible to set an option to the NotAvailable value.

The final value that is common to all options is PrinterCustom. This indicates that the print target supports the functionality but the current selection is custom to this printer. For example, a print target may support a special method for binding the document that is not one of the standard values. In this case a property query on the Binding option will return the PrinterCustom value. Custom output sizes will also be represented as PrinterCustom values but the actual physical sizes will still be available via the GetPageDescription method.

An app may also use PrintTaskOptions to customize the options that appear in the print window. The DisplayedOptions property returns a vector containing the list of option items that will be displayed. Modifications to this list by inserting, appending, removing, or re-ordering options will be reflected in the print window. If a particular print target does not support an option, the option will not be displayed to the user. For the names of the standard options, see StandardPrintTaskOptions.

Here is a JavaScript code snippet that you could use, for example, to set the printed output to color, and also to set the size of the media on which it can be printed:


// Set output to color
printTaskOptions.colorMode = colorMode;

// Set the media size for printing
printTaskOptions.mediaSize = mediaSize;


For more information about the allowed values for these print task options see PrintColorMode and PrintMediaSize.

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

None supported

Namespace

Windows.Graphics.Printing
Windows::Graphics::Printing [C++]

Metadata

Windows.winmd

See also

PrintColorMode
PrintMediaSize
StandardPrintTaskOptions
Windows.Graphics.Printing Enumerations

 

 

Show:
© 2014 Microsoft