如何：以编程方式打印 XPS 文件

项目
05/04/2023

可以使用 AddJob 方法的一个重载来打印 XML 纸张规范 (XPS) 文件，而根本无需打开 PrintDialog 或任何用户界面 (UI)（从原理上讲）。

还还可以使用多种 XpsDocumentWriter.Write 和 XpsDocumentWriter.WriteAsync 方法打印 XPS 文件。有关详细信息，请参阅打印 XPS 文档。

打印 XPS 的另一种方法是使用 PrintDialog.PrintDocument 或 PrintDialog.PrintVisual 方法。请参阅调用打印对话框。

示例

使用三参数 AddJob(String, String, Boolean) 方法的主要步骤如下。以下示例提供了详细信息。

确定打印机是否是 XPSDrv 打印机。有关 XPSDrv 的详细信息，请参阅打印概述。
如果打印机不是 XPSDrv 打印机，将线程的单元设置为单线程。
实例化打印服务器并打印队列对象。
调用该方法，指定作业的名称、要打印的文件和一个 Boolean 标志，该标志指示该打印机是否是 XPSDrv 打印机。

以下示例演示如何以批处理方式打印目录中的所有 XPS 文件。尽管应用程序会提示用户指定目录，但三参数 AddJob(String, String, Boolean) 方法不需要用户界面 (UI)。它可用于具有 XPS 文件名的任何代码路径和可以传递到该方法的路径。

只要 Boolean 参数为 false（使用非 XPSDrv 打印机时，该参数必须为此值），AddJob 的三参数 AddJob(String, String, Boolean) 重载必须在单线程单元中运行。但是，.NET 的默认单元状态为多线程。由于本示例假定使用非 XPSDrv 打印机，因此此默认值必须为相反值。

有两种可用于更改此默认值的方法。一种方法是在应用程序的 Main 方法（通常为“static void Main(string[] args)”）的第一行正上方添加 STAThreadAttribute（即“[System.STAThreadAttribute()]”）即可。但是，许多应用程序要求 Main 方法具有多线程单元状态，因此存在第二种方法：将对 AddJob(String, String, Boolean) 的调用放在单独的线程中，该线程的单元状态通过 SetApartmentState 设置为 STA。以下示例使用第二种方法。

因此，该示例先实例化 Thread 对象，并向其传递 PrintXPS 方法，以用作 ThreadStart 参数。（该示例的后面部分定义了 PrintXPS 方法。）接下来，将线程设置为单线程单元。 Main 方法的唯一剩余代码会启动新线程。

该示例的内容主要关于 staticBatchXPSPrinter.PrintXPS 方法。创建打印服务器和队列后，该方法会提示用户提供包含 XPS 文件的目录。在验证存在该目录且其中存在 *.xps 文件之后，该方法会将每个此类文件添加到打印队列。该示例假定打印机不是 XPSDrv 打印机，因此将向 AddJob(String, String, Boolean) 方法的最后一个参数传递 false。出于此原因，该方法先验证文件中的 XPS 标记，然后再尝试将其转换为打印机的页面描述语言。如果验证失败，会引发异常。该示例代码将捕获该异常，并通知用户相关信息，然后继续处理下一 XPS 文件。

class Program
{
    [System.MTAThreadAttribute()] // Added for clarity, but this line is redundant because MTA is the default.
    static void Main(string[] args)
    {
        // Create the secondary thread and pass the printing method for
        // the constructor's ThreadStart delegate parameter. The BatchXPSPrinter
        // class is defined below.
        Thread printingThread = new Thread(BatchXPSPrinter.PrintXPS);

        // Set the thread that will use PrintQueue.AddJob to single threading.
        printingThread.SetApartmentState(ApartmentState.STA);

        // Start the printing thread. The method passed to the Thread
        // constructor will execute.
        printingThread.Start();
    }//end Main
}//end Program class

public class BatchXPSPrinter
{
    public static void PrintXPS()
    {
        // Create print server and print queue.
        LocalPrintServer localPrintServer = new LocalPrintServer();
        PrintQueue defaultPrintQueue = LocalPrintServer.GetDefaultPrintQueue();

        // Prompt user to identify the directory, and then create the directory object.
        Console.Write("Enter the directory containing the XPS files: ");
        String directoryPath = Console.ReadLine();
        DirectoryInfo dir = new DirectoryInfo(directoryPath);

        // If the user mistyped, end the thread and return to the Main thread.
        if (!dir.Exists)
        {
            Console.WriteLine("There is no such directory.");
        }
        else
        {
            // If there are no XPS files in the directory, end the thread
            // and return to the Main thread.
            if (dir.GetFiles("*.xps").Length == 0)
            {
                Console.WriteLine("There are no XPS files in the directory.");
            }
            else
            {
                Console.WriteLine("\nJobs will now be added to the print queue.");
                Console.WriteLine("If the queue is not paused and the printer is working, jobs will begin printing.");

                // Batch process all XPS files in the directory.
                foreach (FileInfo f in dir.GetFiles("*.xps"))
                {
                    String nextFile = directoryPath + "\\" + f.Name;
                    Console.WriteLine("Adding {0} to queue.", nextFile);

                    try
                    {
                        // Print the Xps file while providing XPS validation and progress notifications.
                        PrintSystemJobInfo xpsPrintJob = defaultPrintQueue.AddJob(f.Name, nextFile, false);
                    }
                    catch (PrintJobException e)
                    {
                        Console.WriteLine("\n\t{0} could not be added to the print queue.", f.Name);
                        if (e.InnerException.Message == "File contains corrupted data.")
                        {
                            Console.WriteLine("\tIt is not a valid XPS file. Use the isXPS Conformance Tool to debug it.");
                        }
                        Console.WriteLine("\tContinuing with next XPS file.\n");
                    }
                }// end for each XPS file
            }//end if there are no XPS files in the directory
        }//end if the directory does not exist

        Console.WriteLine("Press Enter to end program.");
        Console.ReadLine();
    }// end PrintXPS method
}// end BatchXPSPrinter class

Friend Class Program
    <System.MTAThreadAttribute()>
    Shared Sub Main(ByVal args() As String) ' Added for clarity, but this line is redundant because MTA is the default.
        ' Create the secondary thread and pass the printing method for 
        ' the constructor's ThreadStart delegate parameter. The BatchXPSPrinter
        ' class is defined below.
        Dim printingThread As New Thread(AddressOf BatchXPSPrinter.PrintXPS)

        ' Set the thread that will use PrintQueue.AddJob to single threading.
        printingThread.SetApartmentState(ApartmentState.STA)

        ' Start the printing thread. The method passed to the Thread 
        ' constructor will execute.
        printingThread.Start()

    End Sub

End Class

Public Class BatchXPSPrinter
    Public Shared Sub PrintXPS()
        ' Create print server and print queue.
        Dim localPrintServer As New LocalPrintServer()
        Dim defaultPrintQueue As PrintQueue = LocalPrintServer.GetDefaultPrintQueue()

        ' Prompt user to identify the directory, and then create the directory object.
        Console.Write("Enter the directory containing the XPS files: ")
        Dim directoryPath As String = Console.ReadLine()
        Dim dir As New DirectoryInfo(directoryPath)

        ' If the user mistyped, end the thread and return to the Main thread.
        If Not dir.Exists Then
            Console.WriteLine("There is no such directory.")
        Else
            ' If there are no XPS files in the directory, end the thread 
            ' and return to the Main thread.
            If dir.GetFiles("*.xps").Length = 0 Then
                Console.WriteLine("There are no XPS files in the directory.")
            Else
                Console.WriteLine(vbLf & "Jobs will now be added to the print queue.")
                Console.WriteLine("If the queue is not paused and the printer is working, jobs will begin printing.")

                ' Batch process all XPS files in the directory.
                For Each f As FileInfo In dir.GetFiles("*.xps")
                    Dim nextFile As String = directoryPath & "\" & f.Name
                    Console.WriteLine("Adding {0} to queue.", nextFile)

                    Try
                        ' Print the Xps file while providing XPS validation and progress notifications.
                        Dim xpsPrintJob As PrintSystemJobInfo = defaultPrintQueue.AddJob(f.Name, nextFile, False)
                    Catch e As PrintJobException
                        Console.WriteLine(vbLf & vbTab & "{0} could not be added to the print queue.", f.Name)
                        If e.InnerException.Message = "File contains corrupted data." Then
                            Console.WriteLine(vbTab & "It is not a valid XPS file. Use the isXPS Conformance Tool to debug it.")
                        End If
                        Console.WriteLine(vbTab & "Continuing with next XPS file." & vbLf)
                    End Try

                Next f ' end for each XPS file

            End If 'end if there are no XPS files in the directory

        End If 'end if the directory does not exist

        Console.WriteLine("Press Enter to end program.")
        Console.ReadLine()

    End Sub

End Class

如果使用 XPSDrv 打印机，则可将最后一个参数设置为 true。在这种情况下，由于 XPS 是打印机的页面描述语言，该方法会将文件发送到打印机，而不会对其进行验证或将其转换为另一种页面描述语言。如果在设计时不确定应用程序是否会使用 XPSDrv 打印机，可以修改应用程序，使其根据所发现的内容读取 IsXpsDevice 属性和分支。

由于发布 Windows Vista 和 Microsoft .NET Framework 后，最初存在几个可立即使用的 XPSDrv 打印机，可能需要将非 XPSDrv 打印机伪装为 XPSDrv 打印机。为此，请将 Pipelineconfig.xml 添加到运行应用程序的计算机的注册表项中的以下文件列表：

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Environments\Windows NT x86\Drivers\Version-3\<PseudoXPSPrinter>\DependentFiles

其中 <PseudoXPSPrinter> 是任一打印队列。然后必须重新启动计算机。

此伪装允许用户将 true 传递为 AddJob(String, String, Boolean) 的最后一个参数，而不会引发异常，但由于 <PseudoXPSPrinter> 并不是真正的 XPSDrv 打印机，所以仅会打印垃圾内容。

注意

为简单起见，以上示例通过测试是否存在 *.xps 扩展名来确定文件是否为 XPS。但是，XPS 文件不需要具有此扩展名。 isXPS.exe（isXPS 合规性工具）是一种测试文件是否具有 XPS 有效性的方法。

通过

如何：以编程方式打印 XPS 文件

示例

另请参阅

其他资源