Como imprimir arquivos XPS programaticamente
Você pode usar uma sobrecarga do método AddJob para imprimir arquivos XPS (Especificação de Papel XML) sem abrir um PrintDialog ou, em princípio, qualquer interface do usuário.
Você também pode imprimir arquivos XPS usando os vários métodos XpsDocumentWriter.Write e XpsDocumentWriter.WriteAsync. Para obter mais informações, consulte Imprimir um documento XPS.
Outra maneira de imprimir XPS é usar os métodos PrintDialog.PrintDocument ou PrintDialog.PrintVisual. Consulte Abrir um Diálogo de Impressão.
Exemplo
As principais etapas para usar o método AddJob(String, String, Boolean) de três parâmetros são as seguintes. O exemplo a seguir fornece detalhes.
Determine se a impressora é uma impressora XPSDrv. Consulte Visão Geral da Impressão para mais informações sobre o XPSDrv.
Se a impressora não for uma impressora XPSDrv, defina o apartamento do thread como um único thread.
Instancie um servidor de impressão e imprima um objeto de fila.
Chame o método, especificando um nome de trabalho, o arquivo a ser impresso e um sinalizador Boolean indicando se a impressora é ou não uma impressora XPSDrv.
O exemplo a seguir mostra como imprimir em lote todos os arquivos XPS em um diretório. Embora o aplicativo solicite ao usuário que especifique o diretório, o método de AddJob(String, String, Boolean) de três parâmetros não exige uma interface do usuário (interface do usuário). Ele pode ser usado em qualquer caminho de código em que você tenha um nome de arquivo XPS e um caminho que você possa passar para ele.
A sobrecarga de AddJob(String, String, Boolean) de três parâmetros de AddJob deve ser executada em um único apartamento de thread sempre que o parâmetro Boolean for false
, o que deve ocorrer quando se utiliza uma impressora que não seja XPSDrv. No entanto, o estado de apartamento padrão para .NET é multithread. Esse padrão deve ser invertido, pois o exemplo pressupõe uma impressora não XPSDrv.
Há duas maneiras de alterar o padrão. Uma maneira é simplesmente adicionar o STAThreadAttribute (ou seja, "[System.STAThreadAttribute()]
") logo acima da primeira linha do método Main
do aplicativo (geralmente "static void Main(string[] args)
"). No entanto, muitos aplicativos exigem que o método Main
tenha um estado de apartamento com vários threads, portanto, há um segundo método: colocar a chamada para AddJob(String, String, Boolean) em um thread separado cujo estado de apartamento está definido como STA com SetApartmentState. O exemplo a seguir usa essa segunda técnica.
Assim, o exemplo começa criando uma instância de um objeto Thread e passando-lhe um método printXPS como o parâmetro ThreadStart. (O método PrintXPS é definido posteriormente no exemplo.) Em seguida, a thread é configurada para um modelo de apartamento de thread único. O único código restante do método Main
inicia o novo thread.
O essencial do exemplo está no método static
BatchXPSPrinter.PrintXPS. Depois de criar um servidor de impressão e uma fila, o método solicita ao usuário um diretório que contém arquivos XPS. Depois de validar a existência do diretório e a presença de arquivos *.xps nele, o método adiciona cada um desses arquivos à fila de impressão. O exemplo pressupõe que a impressora não seja XPSDrv, portanto, estamos passando false
para o último parâmetro do método AddJob(String, String, Boolean). Por esse motivo, o método validará a marcação XPS no arquivo antes de tentar convertê-la no idioma de descrição da página da impressora. Se a validação falhar, uma exceção será gerada. O código de exemplo capturará a exceção, notificará o usuário sobre ela e, em seguida, processará o próximo arquivo 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
Se você estiver usando uma impressora XPSDrv, poderá definir o parâmetro final como true
. Nesse caso, como o XPS é a linguagem de descrição da página da impressora, o método enviará o arquivo para a impressora sem validá-lo ou convertê-lo em outro idioma de descrição de página. Se você não tiver certeza na fase de design se o aplicativo usará uma impressora XPSDrv, poderá modificar o aplicativo para que ele leia a propriedade IsXpsDevice e tome decisões de acordo com o que encontrar.
Como inicialmente haverá poucas impressoras XPSDrv disponíveis imediatamente após o lançamento do Windows Vista e do Microsoft .NET Framework, talvez seja necessário disfarçar uma impressora não XPSDrv como uma impressora XPSDrv. Para fazer isso, adicione Pipelineconfig.xml à lista de arquivos na seguinte chave do Registro do computador que executa seu aplicativo:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Environments\Windows NT x86\Drivers\Version-3\<PseudoXPSPrinter>\DependentFiles
em que <pseudoXPSPrinter> é qualquer fila de impressão. Em seguida, o computador deve ser reinicializado.
Esse disfarce permitirá que você passe true
como o parâmetro final de AddJob(String, String, Boolean) sem causar uma exceção, mas como <PseudoXPSPrinter> não é realmente uma impressora XPSDrv, somente o lixo será impresso.
Nota
Para simplificar, o exemplo acima usa a presença de uma extensão *.xps como teste de que um arquivo é XPS. No entanto, os arquivos XPS não precisam ter essa extensão. O isXPS.exe (isXPS Conformance Tool) é uma maneira de testar um arquivo para validade XPS.
Consulte também
- PrintQueue
- AddJob
- ApartmentState
- STAThreadAttribute
- documentos XPS
- imprimir um documento XPS
- de threading gerenciado e não gerenciado
- isXPS.exe (isXPS Conformance Tool)
- documentos no WPF
- Visão geral da impressão
.NET Desktop feedback