Share via

PrintSupportSettingsUISession Class

  • Reference

Definition

Namespace:
Windows.Graphics.Printing.PrintSupport
Edit

Represents a session of the print support settings UI.

public ref class PrintSupportSettingsUISession sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 851968)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class PrintSupportSettingsUISession final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 851968)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class PrintSupportSettingsUISession
Public NotInheritable Class PrintSupportSettingsUISession
Inheritance
Object Platform::Object IInspectable PrintSupportSettingsUISession
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 settings UI extension, your app must declare a uap4:Extension element with the category windows.printSupportSettingsUI in its package manifest. When the app is activated, the OnActivated method receives a PrintSupportSettingsActivatedEventArgs object that provides access to information about the print support UI session. The Session property of that object returns a PrintSupportSettingsUISession object.

For more information, see Print support app design guide.

Properties

DocumentTitle

Gets the title of the document that is being printed.
LaunchKind

Gets a value that indicates the type of operation that launched the print support settings UI.
SessionInfo

Gets an object that provides information about the current session of the print support settings UI.
SessionPrintTicket

Gets the print ticket for the current session. The print ticket contains instructions on how the printer should set its various features for a printing task.

Methods

UpdatePrintTicket(WorkflowPrintTicket)

Updates the print ticket for the current session with the information in the specified print ticket object.

Applies to

See also