PrintTaskOptions Class

Reference

Definition

Namespace:: Windows.Graphics.Printing

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

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

public ref class PrintTaskOptions sealed : IPrintTaskOptionsCore, IPrintTaskOptionsCoreProperties, IPrintTaskOptionsCoreUIConfiguration

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class PrintTaskOptions final : IPrintTaskOptionsCore, IPrintTaskOptionsCoreProperties, IPrintTaskOptionsCoreUIConfiguration

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class PrintTaskOptions : IPrintTaskOptionsCore, IPrintTaskOptionsCoreProperties, IPrintTaskOptionsCoreUIConfiguration

Public NotInheritable Class PrintTaskOptions
Implements IPrintTaskOptionsCore, IPrintTaskOptionsCoreProperties, IPrintTaskOptionsCoreUIConfiguration

Inheritance: Object Platform::Object IInspectable PrintTaskOptions

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Implements: IPrintTaskOptionsCore IPrintTaskOptionsCoreProperties IPrintTaskOptionsCoreUIConfiguration

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

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 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. The PrintTaskOptions object is accessed through the PrintTask.Options property.

// Set output to color
printTask.Options.ColorMode = PrintColorMode.Color;

// Set the media size for printing
printTask.Options.MediaSize = PrintMediaSize.NorthAmericaLegal;

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

Version history

Windows version	SDK version	Value added
1607	14393	Bordering
1607	14393	GetPagePrintTicket
1803	17134	CustomPageRanges
1803	17134	PageRangeOptions

Properties

Binding	Gets or sets the binding option for the print task.
Bordering	Gets or sets the bordering option for the print task.
Collation	Gets or sets the collation option of the print tasks.
ColorMode	Gets or sets the color mode option of the print task.
CustomPageRanges	Gets the custom page range options for the print task.
DisplayedOptions	Gets the list of options displayed for the print experience.
Duplex	Gets or sets the duplex option of the print task.
HolePunch	Gets or sets the hole punch option of the print task.
MaxCopies	Gets the maximum number of copies supported for the print task.
MediaSize	Gets or sets the media size option of the print task.
MediaType	Gets or sets the media type option for the print task.
MinCopies	Gets the minimum number of copies allowed for the print task.
NumberOfCopies	Gets or sets the value for the number of copies for the print task.
Orientation	Gets or sets the orientation option for the print task.
PageRangeOptions	Gets the page range options for the print task.
PrintQuality	Gets or sets the print quality option for the print task.
Staple	Gets or sets the staple option for the print task.

Methods

GetPageDescription(UInt32)	Retrieves the physical dimensions of the printed page.
GetPagePrintTicket(PrintPageInfo)	Retrieves the physical dimensions and formatting data of a printed page.

Applies to

Jaa