Share via

PrintWorkflowJobBackgroundSession Class

  • Reference

Definition

Namespace:
Windows.Graphics.Printing.Workflow
Edit

Represents a single print workflow job session that runs in the background.

public ref class PrintWorkflowJobBackgroundSession sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 851968)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class PrintWorkflowJobBackgroundSession final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 851968)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class PrintWorkflowJobBackgroundSession
Public NotInheritable Class PrintWorkflowJobBackgroundSession
Inheritance
Object Platform::Object IInspectable PrintWorkflowJobBackgroundSession
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family
Windows 11 (introduced in 10.0.22000.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v14.0)

Remarks

To create a print support workflow, your app must declare a uap4:Extension element with the category windows.printSupportWorkflow in its package manifest that specifies the entry point of a background task. When the background task is activated, the IBackgroundTask.Run method receives an IBackgroundTaskInstance object. You can cast the TriggerDetails property of this object to a PrintWorkflowJobTriggerDetails object to get more details about the print workflow job session.

For more information, see Print support app design guide.

Properties

Status

Gets the status of the current print workflow session.

Methods

Start()

Starts the print workflow job service so it can begin raising events.

Events

JobIssueDetected
JobStarting

Raised when a print job is started by a print workflow app. Your print workflow app can use members of the event args object to skip system rendering or modify the operation in other ways.
PdlModificationRequested

Raised when a document is sent to the print stack and Windows starts to convert the document to the page description language (PDL) format indicated by the printer. Your print workflow app can use members of the event args object to modify the conversion to the page description language (PDL) format indicated by the printer.

Applies to

See also