Share via


WorkflowPrintTicket Class

Definition

This class represents an XML PrintTicket document and allows it to be modified easily. The PrintTicket document contains instructions on how the printer should set its various features for a printing task.

public ref class WorkflowPrintTicket sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class WorkflowPrintTicket final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class WorkflowPrintTicket
Public NotInheritable Class WorkflowPrintTicket
Inheritance
Object Platform::Object IInspectable WorkflowPrintTicket
Attributes

Windows requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

Properties

DocumentBindingFeature

Gets the document binding configuration for this print ticket.

DocumentCollateFeature

Gets the document collation configuration for this print ticket.

DocumentDuplexFeature

Gets the duplex printing configuration for this print ticket.

DocumentHolePunchFeature

Gets the document hole-punch configuration for this print ticket.

DocumentInputBinFeature

Gets the printing input bin configuration for this print ticket.

DocumentNUpFeature

Gets the N-up printing configuration for this print ticket.

DocumentStapleFeature

Gets the document staple configuration for this print ticket.

JobPasscodeFeature

Gets the job passcode configuration for this print ticket.

Name

Gets the canonical name of this print ticket.

PageBorderlessFeature

Gets the document borderless configuration for this print ticket.

PageMediaSizeFeature

Gets the page media size configuration for this print ticket.

PageMediaTypeFeature

Gets the page media type configuration for this print ticket.

PageOrientationFeature

Gets the page orientation configuration for this print ticket.

PageOutputColorFeature

Gets the page color configuration for this print ticket.

PageOutputQualityFeature

Gets the page quality configuration for this print ticket.

PageResolutionFeature

Gets the page resolution configuration for this print ticket.

XmlNamespace

Gets the XML namespace for the print ticket.

XmlNode

Gets the XML node for the print ticket.

Methods

GetCapabilities()

Gets the print capabilities object for this print ticket.

GetFeature(String, String)

Gets the specified print feature object.

GetParameterInitializer(String, String)

Gets the parameter initializer object for a specified printing parameter.

MergeAndValidateTicket(WorkflowPrintTicket)

Merges a newly configured print ticket onto the current print ticket and validates the merged ticket, guaranteeing that it does not ask for any printing functionality that the printer does not support.

NotifyXmlChangedAsync()

Notifies the print system that the XML DOM object has changed.

SetParameterInitializerAsInteger(String, String, Int32)

Sets the parameter initializer object for a specified printing parameter. This can only be done if an initializer for the specified parameter doesn't yet exist.

SetParameterInitializerAsString(String, String, String)

Sets the given print parameter to the given string value. This can only be done if an initializer for the specified parameter doesn't yet exist.

ValidateAsync()

Checks that the given print ticket does not ask for any printing functionality that the printer does not support.

Applies to

See also