PrintWorkflowForegroundSession Class

Definition

Namespace:

Windows.Graphics.Printing.Workflow

Represents a single print workflow session that runs in the foreground.

public ref class PrintWorkflowForegroundSession 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 PrintWorkflowForegroundSession 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 PrintWorkflowForegroundSession

Public NotInheritable Class PrintWorkflowForegroundSession

Inheritance

Object Platform::Object IInspectable PrintWorkflowForegroundSession

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

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

Remarks

An instance of this class is acquired from the PrintWorkflowUIActivatedEventArgs instance that gets passed in with foreground task activation.

Properties

Status

The status of the current print workflow session.

Methods

Start()

Starts the print workflow foreground process. The events of this class are raised in sequential order.

Events

SetupRequested	Raised first in the print workflow foreground session. This event exposes information about the print job but not the print content itself. Register for this event to do UI-dependent work on the print job before printing.
XpsDataAvailable	Raised when the XPS print data is available to be read. This is done after the SetupRequested event is raised. Register for this event to do UI-dependent work that requires displaying the print content.