PrintManager PrintManager PrintManager PrintManager PrintManager Class

Definition

Informs Windows that an application wishes to participate in printing. The PrintManager class is also used for programmatically initiating printing.

public : sealed class PrintManager : IPrintManager
struct winrt::Windows::Graphics::Printing::PrintManager : IPrintManager
public sealed class PrintManager : IPrintManager
Public NotInheritable Class PrintManager Implements IPrintManager
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

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

Remarks

The PrintManager class is responsible for orchestrating the printing flow for UWP app. To use this class, you must first call the GetForCurrentView method. This method returns the PrintManager object that is specific to the current active window. Next, you must add an event listener for the PrintTaskRequested event. This event is raised by the system when a user indicates the possibility of initiating a printing operation. Typically this occurs when the user taps the Devices charm, but the event may also be invoked programmatically.

When a UWP app registers its "intention" to print, it creates a print contract with the print manager. Here is a JavaScript code snippet to show how to register your app for a print contract using a PrintManager:

    var app = WinJS.Application;

    // This function responds to all application activations.
    app.onactivated = function (eventObject) {
        if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.launch) {

            //Register for print contract
            var printManager = Windows.Graphics.Printing.PrintManager.getForCurrentView();
            printManager.onprinttaskrequested = onPrintTaskRequested;

            WinJS.UI.processAll();
        }
    };

For more examples involving the print manager and to see some sample code for printing scenarios in UWP apps, see Printing in the Windows Dev Center.

Methods

GetForCurrentView() GetForCurrentView() GetForCurrentView() GetForCurrentView() GetForCurrentView()

Retrieves the PrintManager object associated with the current window.

IsSupported() IsSupported() IsSupported() IsSupported() IsSupported()

Indicates whether or not the app is running on a device that supports printing.

ShowPrintUIAsync() ShowPrintUIAsync() ShowPrintUIAsync() ShowPrintUIAsync() ShowPrintUIAsync()

Programmatically initiates the user interface for printing content.

Events

PrintTaskRequested PrintTaskRequested PrintTaskRequested PrintTaskRequested PrintTaskRequested

Raised when a request to print has occurred. This event may be triggered by user action or via programmatic invocation of printing via the ShowPrintUIAsync method.

See also