Jak wydrukować plik XPS (WPF .NET)

  • Artykuł

Czasami należy dodać nowe zadanie drukowania do kolejki wydruku bez otwierania okna dialogowego drukowania. Aby to zrobić, możesz użyć jednej z PrintQueue.AddJob metod. Oto, jak to zrobić.

Ważne

Dokumentacja przewodnika dla komputerów dla platform .NET 7 i .NET 6 jest w budowie.

W poniższym przykładzie użyjemy AddJob(String, String, Boolean) metody , jednej z kilku przeciążeń AddJobklasy , aby:

  • Dodaj nowe zadanie drukowania dokumentu specyfikacji papieru XML (XPS) do domyślnej kolejki wydruku.
  • Nadaj nowe zadanie nazwę.
  • Określ, czy dokument XPS ma zostać zweryfikowany (przy użyciu parametru fastCopy ).

W przypadku korzystania z AddJob(String, String, Boolean) metody wartość parametru fastCopy jest kluczową kwestią:

  • Jeśli ustawisz parametr na fastCopytruewartość , walidacja XPS zostanie pominięta, a zadanie drukowania będzie szybko buforować bez opinii o postępie strony po stronie.
  • Jeśli ustawisz fastCopy parametr na false, wątek, który wywołuje AddJob metodę , musi mieć stan apartamentu jednowątkowego, w przeciwnym razie zostanie zgłoszony wyjątek. Aby uzyskać więcej informacji, zobacz sekcję Uwagi dotyczące AddJob(String, String, Boolean)programu .

Dodawanie nowych zadań drukowania do kolejki

W tym przykładzie do kolejki domyślnej zostanie dodany co najmniej jeden dokument XPS. Kod będzie:

  1. Użyj polecenia Task.Run , aby uniknąć blokowania wątku interfejsu użytkownika — ponieważ nie ma asynchronicznych wersji programu AddJob.
  2. Jeśli wartość parametru fastCopy to false, uruchom polecenie AddJob(String, String, Boolean) w wątku ze stanem apartamentu jednowątkowego.
  3. Pobierz odwołanie do domyślnego PrintQueue elementu LocalPrintServer.
  4. Wywołaj AddJob(String, String, Boolean) odwołanie do kolejki wydruku, przekazując nazwę zadania, ścieżkę dokumentu XPS i fastCopy parametr.

Jeśli kolejka nie jest wstrzymana i drukarka działa, zadanie drukowania rozpocznie się automatycznie po osiągnięciu górnej części kolejki wydruku.

Napiwek

Aby uniknąć okna dialogowego Zapisywanie pliku wyjściowego jako podczas dodawania zadania drukowania do kolejki domyślnej, upewnij się, że drukarka domyślna nie jest składnikiem zapisywania dokumentów w systemie Microsoft XPS, microsoft print to PDF lub innymi opcjami drukowania do pliku.

/// <summary>
/// Asyncronously, add a batch of XPS documents to the print queue using a PrintQueue.AddJob method.
/// Handle the thread apartment state required by the PrintQueue.AddJob method.
/// </summary>
/// <param name="xpsFilePaths">A collection of XPS documents.</param>
/// <param name="fastCopy">Whether to validate the XPS documents.</param>
/// <returns>Whether all documents were added to the print queue.</returns>
public static async Task<bool> BatchAddToPrintQueueAsync(IEnumerable<string> xpsFilePaths, bool fastCopy = false)
{
    bool allAdded = true;

    // Queue some work to run on the ThreadPool.
    // Wait for completion without blocking the calling thread.
    await Task.Run(() =>
    {
        if (fastCopy)
            allAdded = BatchAddToPrintQueue(xpsFilePaths, fastCopy);
        else
        {
            // Create a thread to call the PrintQueue.AddJob method.
            Thread newThread = new(() =>
            {
                allAdded = BatchAddToPrintQueue(xpsFilePaths, fastCopy);
            });

            // Set the thread to single-threaded apartment state.
            newThread.SetApartmentState(ApartmentState.STA);

            // Start the thread.
            newThread.Start();

            // Wait for thread completion. Blocks the calling thread,
            // which is a ThreadPool thread.
            newThread.Join();
        }
    });

    return allAdded;
}

/// <summary>
/// Add a batch of XPS documents to the print queue using a PrintQueue.AddJob method.
/// </summary>
/// <param name="xpsFilePaths">A collection of XPS documents.</param>
/// <param name="fastCopy">Whether to validate the XPS documents.</param>
/// <returns>Whether all documents were added to the print queue.</returns>
public static bool BatchAddToPrintQueue(IEnumerable<string> xpsFilePaths, bool fastCopy)
{
    bool allAdded = true;

    // To print without getting the "Save Output File As" dialog, ensure
    // that your default printer is not the Microsoft XPS Document Writer,
    // Microsoft Print to PDF, or other print-to-file option.

    // Get a reference to the default print queue.
    PrintQueue defaultPrintQueue = LocalPrintServer.GetDefaultPrintQueue();

    // Iterate through the document collection.
    foreach (string xpsFilePath in xpsFilePaths)
    {
        // Get document name.
        string xpsFileName = Path.GetFileName(xpsFilePath);

        try
        {
            // The AddJob method adds a new print job for an XPS
            // document into the print queue, and assigns a job name.
            // Use fastCopy to skip XPS validation and progress notifications.
            // If fastCopy is false, the thread that calls PrintQueue.AddJob
            // must have a single-threaded apartment state.
            PrintSystemJobInfo xpsPrintJob =
                    defaultPrintQueue.AddJob(jobName: xpsFileName, documentPath: xpsFilePath, fastCopy);

            // If the queue is not paused and the printer is working, then jobs will automatically begin printing.
            Debug.WriteLine($"Added {xpsFileName} to the print queue.");
        }
        catch (PrintJobException e)
        {
            allAdded = false;
            Debug.WriteLine($"Failed to add {xpsFileName} to the print queue: {e.Message}\r\n{e.InnerException}");
        }
    }

    return allAdded;
}

''' <summary>
''' Asyncronously, add a batch of XPS documents to the print queue using a PrintQueue.AddJob method.
''' Handle the thread apartment state required by the PrintQueue.AddJob method.
''' </summary>
''' <param name="xpsFilePaths">A collection of XPS documents.</param>
''' <param name="fastCopy">Whether to validate the XPS documents.</param>
''' <returns>Whether all documents were added to the print queue.</returns>
Public Shared Async Function BatchAddToPrintQueueAsync(xpsFilePaths As IEnumerable(Of String), Optional fastCopy As Boolean = False) As Task(Of Boolean)

    Dim isAllPrinted As Boolean = True

    ' Queue some work to run on the ThreadPool.
    ' Wait for completion without blocking the calling thread.
    Await Task.Run(
        Sub()
            If fastCopy Then
                isAllPrinted = BatchAddToPrintQueue(xpsFilePaths, fastCopy)
            Else
                ' Create a thread to call the PrintQueue.AddJob method.
                Dim newThread As New Thread(
                    Sub()
                        isAllPrinted = BatchAddToPrintQueue(xpsFilePaths, fastCopy)
                    End Sub
                )

                ' Set the thread to single-threaded apartment state.
                newThread.SetApartmentState(ApartmentState.STA)

                ' Start the thread.
                newThread.Start()

                ' Wait for thread completion. Blocks the calling thread,
                ' which is a ThreadPool thread.
                newThread.Join()
            End If
        End Sub
    )

    Return isAllPrinted

End Function

''' <summary>
''' Add a batch of XPS documents to the print queue using a PrintQueue.AddJob method.
''' </summary>
''' <param name="xpsFilePaths">A collection of XPS documents.</param>
''' <param name="fastCopy">Whether to validate the XPS documents.</param>
''' <returns>Whether all documents were added to the print queue.</returns>
Public Shared Function BatchAddToPrintQueue(xpsFilePaths As IEnumerable(Of String), fastCopy As Boolean) As Boolean

    Dim isAllPrinted As Boolean = True

    ' To print without getting the "Save Output File As" dialog, ensure
    ' that your default printer is not the Microsoft XPS Document Writer,
    ' Microsoft Print to PDF, or other print-to-file option.

    ' Get a reference to the default print queue.
    Dim defaultPrintQueue As PrintQueue = LocalPrintServer.GetDefaultPrintQueue()

    ' Iterate through the document collection.
    For Each xpsFilePath As String In xpsFilePaths

        ' Get document name.
        Dim xpsFileName As String = Path.GetFileName(xpsFilePath)

        Try
            ' The AddJob method adds a new print job for an XPS
            ' document into the print queue, and assigns a job name.
            ' Use fastCopy to skip XPS validation and progress notifications.
            ' If fastCopy is false, the thread that calls PrintQueue.AddJob
            ' must have a single-threaded apartment state.
            Dim xpsPrintJob As PrintSystemJobInfo = defaultPrintQueue.AddJob(jobName:=xpsFileName, documentPath:=xpsFilePath, fastCopy)

            ' If the queue is not paused and the printer is working, then jobs will automatically begin printing.
            Debug.WriteLine($"Added {xpsFileName} to the print queue.")
        Catch e As PrintJobException
            isAllPrinted = False
            Debug.WriteLine($"Failed to add {xpsFileName} to the print queue: {e.Message}\r\n{e.InnerException}")
        End Try
    Next

    Return isAllPrinted

End Function

Napiwek

Możesz również drukować pliki XPS przy użyciu:

Aby uzyskać więcej informacji, zobacz Jak wyświetlić okno dialogowe drukowania i Omówienie drukowania dokumentów.

Zobacz też