PrintQueue.AddJob Methode

Referenz

Definition

Namespace:: System.Printing

Assembly:: System.Printing.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Fügt einen neuen Druckauftrag in die Warteschlange ein.

Überlädt

AddJob(String, String, Boolean, PrintTicket)	Fügt einen neuen Druckauftrag für ein XPS-Dokument (XML Paper Specification) in die Warteschlange ein, gibt den angegebenen Namen und die angegebenen Einstellungen an und gibt an, ob er überprüft werden soll.
AddJob(String, PrintTicket)	Fügt einen neuen Druckauftrag für ein XPS-Dokument (XML Paper Specification) in die Warteschlange ein und gibt ihr den angegebenen Namen und die angegebenen Einstellungen.
AddJob(String, String, Boolean)	Fügt einen neuen Druckauftrag für ein XPS-Dokument (XML Paper Specification) in die Warteschlange ein, gibt den angegebenen Namen an und gibt an, ob er überprüft werden soll.
AddJob()	Fügt einen neuen (i. d. R. einen angegebenen) Druckauftrag, dessen Inhalt ein Byte-Array ist, in die Warteschlange ein.
AddJob(String)	Fügt einen neuen Druckauftrag, dessen Inhalt ein Byte-Array ist, in die Warteschlange ein.

Hinweise

Sofern die Warteschlange nicht angehalten ist oder sich in einem Fehlerzustand befindet, wird der Auftrag gedruckt, wenn er den oberen Rand der Warteschlange erreicht, sodass es sich um eine Druckfunktion handelt.

Weitere Möglichkeiten zum Drucken in Windows Presentation Foundation (WPF) sind die PrintDialog.PrintDocument -Methode, die mit oder ohne Öffnen des Dialogfelds verwendet werden kann, und die vielen Write - und WriteAsync -Methoden von XpsDocumentWriter.

AddJob(String, String, Boolean, PrintTicket)

Fügt einen neuen Druckauftrag für ein XPS-Dokument (XML Paper Specification) in die Warteschlange ein, gibt den angegebenen Namen und die angegebenen Einstellungen an und gibt an, ob er überprüft werden soll.

public:
 System::Printing::PrintSystemJobInfo ^ AddJob(System::String ^ jobName, System::String ^ documentPath, bool fastCopy, System::Printing::PrintTicket ^ printTicket);

public System.Printing.PrintSystemJobInfo AddJob (string jobName, string documentPath, bool fastCopy, System.Printing.PrintTicket printTicket);

member this.AddJob : string * string * bool * System.Printing.PrintTicket -> System.Printing.PrintSystemJobInfo

Public Function AddJob (jobName As String, documentPath As String, fastCopy As Boolean, printTicket As PrintTicket) As PrintSystemJobInfo

Parameter

jobName: String

Der Pfad und Name des Dokuments, das gedruckt wird.

documentPath: String

Der Pfad und Name des Dokuments, das gedruckt wird.

fastCopy: Boolean

true schnell ohne Feedback zum Seitenstatus und ohne Überprüfung, dass die Datei gültige XPS ist, schnell zu spoolen; falseandernfalls .

printTicket: PrintTicket

Die Einstellungen des Druckauftrags.

Gibt zurück

PrintSystemJobInfo

Eine PrintSystemJobInfo, die den Druckauftrag und seinen Status darstellt.

Hinweise

Weitere Informationen finden Sie unter AddJob(String, String, Boolean).

Gilt für:

AddJob(String, PrintTicket)

Fügt einen neuen Druckauftrag für ein XPS-Dokument (XML Paper Specification) in die Warteschlange ein und gibt ihr den angegebenen Namen und die angegebenen Einstellungen.

public:
 System::Printing::PrintSystemJobInfo ^ AddJob(System::String ^ jobName, System::Printing::PrintTicket ^ printTicket);

public System.Printing.PrintSystemJobInfo AddJob (string jobName, System.Printing.PrintTicket printTicket);

member this.AddJob : string * System.Printing.PrintTicket -> System.Printing.PrintSystemJobInfo

Public Function AddJob (jobName As String, printTicket As PrintTicket) As PrintSystemJobInfo

Parameter

jobName: String

Der Pfad und Name des Dokuments, das gedruckt wird.

printTicket: PrintTicket

Die Einstellungen des Druckauftrags.

Gibt zurück

PrintSystemJobInfo

Eine PrintSystemJobInfo, die den Druckauftrag und seinen Status darstellt.

Hinweise

Weitere Informationen finden Sie unter AddJob(String).

Gilt für:

AddJob(String, String, Boolean)

Fügt einen neuen Druckauftrag für ein XPS-Dokument (XML Paper Specification) in die Warteschlange ein, gibt den angegebenen Namen an und gibt an, ob er überprüft werden soll.

public:
 System::Printing::PrintSystemJobInfo ^ AddJob(System::String ^ jobName, System::String ^ documentPath, bool fastCopy);

public System.Printing.PrintSystemJobInfo AddJob (string jobName, string documentPath, bool fastCopy);

member this.AddJob : string * string * bool -> System.Printing.PrintSystemJobInfo

Public Function AddJob (jobName As String, documentPath As String, fastCopy As Boolean) As PrintSystemJobInfo

Parameter

jobName: String

Der Name des Druckauftrags.

documentPath: String

Der Pfad und Name des Dokuments, das gedruckt wird.

fastCopy: Boolean

true schnell ohne Feedback zum Seitenstatus und ohne Überprüfung, dass die Datei gültige XPS ist, schnell zu spoolen; falseandernfalls .

Gibt zurück

PrintSystemJobInfo

Eine PrintSystemJobInfo, die den Druckauftrag und seinen Status darstellt.

Beispiele

Im folgenden Beispiel wird gezeigt, wie sie zum Batchdrucken aller XPS-Dateien (XML Paper Specification) in einem Verzeichnis verwenden AddJob(String, String, Boolean) .

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();
    }
}

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");
                    }
                }
            }
        }

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

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

Hinweise

Wenn fastCopy ist true, muss der Drucker eine Druckübersicht sein. Andernfalls löst die AddJob(String, String, Boolean) -Methode eine Ausnahme aus.

Wenn fastCopy ist false, ist es nicht erforderlich, einen XPSDrv-Drucker zu verwenden. Die XPS-Datei, die der Warteschlange hinzugefügt wird, wird in die Seitenbeschreibungssprache des Druckers konvertiert, z. B. PCL oder Postscript. Diese Art des Druckens ruft jedoch das Component Object Model (COM) auf. Der Aufruf von COM erfordert, dass der aufrufende Thread über ein Singlethread-Apartment (STA) anstelle von Mehrthread-Apartment (MTA) verfügt, was in Microsoft .NET 2.0 und höher standardmäßig ist. (Weitere Informationen zu Threading- und Apartmentstatus finden Sie unter Verwaltete und nicht verwaltete Threading und ApartmentState.) Hierfür gibt es zwei Möglichkeiten:

Die einfachste Möglichkeit besteht darin, das STAThreadAttribute -Element (d. a. "[System.STAThreadAttribute()]") direkt über der ersten Zeile der Methode der Anwendung Main (in der Regel "static void Main(string[] args)") hinzuzufügen.
Wenn Sie den Wohnungsstatus Ihres Main Threads benötigen, können Sie den Aufruf von AddJob(String, String, Boolean) in einem separaten Thread unterstellen, dessen Wohnungsstatus mit STA SetApartmentStatefestgelegt MTAist. Das folgende Beispiel veranschaulicht diese zweite Technik.

Hinweis

Sie können die STAThreadAttribute auf keine Methode anwenden, außer Main sie können sie nicht für den Main Thread verwendenSetApartmentState.

Weitere Informationen

Gilt für:

AddJob()

Fügt einen neuen (i. d. R. einen angegebenen) Druckauftrag, dessen Inhalt ein Byte-Array ist, in die Warteschlange ein.

public:
 System::Printing::PrintSystemJobInfo ^ AddJob();

public System.Printing.PrintSystemJobInfo AddJob ();

member this.AddJob : unit -> System.Printing.PrintSystemJobInfo

Public Function AddJob () As PrintSystemJobInfo

Gibt zurück

PrintSystemJobInfo

Eine PrintSystemJobInfo, die den Druckauftrag und seinen Status darstellt.

Beispiele

Im folgenden Beispiel wird gezeigt, wie sie verwenden, AddJob() um ein Byte Array an eine Druckwarteschlange zu senden. Dieser Code funktioniert nur mit Druckern, die Nur-Text erkennen und drucken können. Einige von ihnen können es nicht.

// Create the printer server and print queue objects
LocalPrintServer localPrintServer = new LocalPrintServer();
PrintQueue defaultPrintQueue = LocalPrintServer.GetDefaultPrintQueue();

// Call AddJob
PrintSystemJobInfo myPrintJob = defaultPrintQueue.AddJob();

// Write a Byte buffer to the JobStream and close the stream
Stream myStream = myPrintJob.JobStream;
Byte[] myByteBuffer = UnicodeEncoding.Unicode.GetBytes("This is a test string for the print job stream.");
myStream.Write(myByteBuffer, 0, myByteBuffer.Length);
myStream.Close();

' Create the printer server and print queue objects
Dim localPrintServer As New LocalPrintServer()
Dim defaultPrintQueue As PrintQueue = LocalPrintServer.GetDefaultPrintQueue()

' Call AddJob
Dim myPrintJob As PrintSystemJobInfo = defaultPrintQueue.AddJob()

' Write a Byte buffer to the JobStream and close the stream
Dim myStream As Stream = myPrintJob.JobStream
Dim myByteBuffer() As Byte = UnicodeEncoding.Unicode.GetBytes("This is a test string for the print job stream.")
myStream.Write(myByteBuffer, 0, myByteBuffer.Length)
myStream.Close()

Hinweise

Verwenden Sie diese Methode, um gerätespezifische Informationen in eine Spooldatei zu schreiben, die nicht automatisch vom Microsoft Windows-Spooler enthalten ist. Natürlich müssen Sie wissen, ob es sich bei der Spooldatei um eine erweiterte Metadatei (EMF) oder um xml Paper Specification (XPS) handelt. Wenn Sie lieber mit der Stream API arbeiten möchten, können Sie die PrintQueueStream -Klasse anstelle dieser Methode verwenden.

Nachdem die AddJob Methode aufgerufen wurde, müssen Sie ein Byte Array in die JobStream Eigenschaft des schreiben, das PrintSystemJobInfo von AddJob zurückgegeben wird, oder es wird kein Druckauftrag erstellt. Dieses Array druckt, wenn der Drucker funktioniert und nicht angehalten wird.

Achtung

Wenn nicht JobStream mit Close geschlossen wird, bevor das Ende des Threads, in AddJob dem aufgerufen wird, wird ein InvalidOperationException ausgelöst, wenn dieser Thread endet, da der Spoolerthread keine Kontrolle über das Stream Objekt erlangen kann.

In der grafischen Benutzeroberfläche (GUI) der Druckwarteschlange hat der Auftrag den Namen "Systemdokument drucken". Verwenden Sie die Überladung, um dem Auftrag einen anderen Namen zu geben AddJob(String) .

Gilt für:

AddJob(String)

Fügt einen neuen Druckauftrag, dessen Inhalt ein Byte-Array ist, in die Warteschlange ein.

public:
 System::Printing::PrintSystemJobInfo ^ AddJob(System::String ^ jobName);

public System.Printing.PrintSystemJobInfo AddJob (string jobName);

member this.AddJob : string -> System.Printing.PrintSystemJobInfo

Public Function AddJob (jobName As String) As PrintSystemJobInfo

Parameter

jobName: String

Der Name des Druckauftrags.

Gibt zurück

PrintSystemJobInfo

Eine PrintSystemJobInfo, die den Druckauftrag und seinen Status darstellt.

Beispiele

Das folgende Beispiel zeigt, wie AddJob(String) Sie eine Datei in ein Byte Array lesen und das Array an eine Druckwarteschlange senden. Dieser Code setzt voraus, dass im Stammverzeichnis des Laufwerks C: eine Datei namens test.txt vorhanden ist. Dieser Code funktioniert nur mit Druckern, die Nur-Text erkennen und drucken können. Einige von ihnen können es nicht.

// Create the printer server and print queue objects
LocalPrintServer localPrintServer2 = new LocalPrintServer();
PrintQueue defaultPrintQueue2 = LocalPrintServer.GetDefaultPrintQueue();

// Call AddJob 
PrintSystemJobInfo anotherPrintJob = defaultPrintQueue2.AddJob("MyJob");

// Read a file into a StreamReader
StreamReader myStreamReader = new StreamReader("C:\\test.txt");

// Write a Byte buffer to the JobStream and close the stream
Stream anotherStream = anotherPrintJob.JobStream;
Byte[] anotherByteBuffer = UnicodeEncoding.Unicode.GetBytes(myStreamReader.ReadToEnd());
anotherStream.Write(anotherByteBuffer, 0, anotherByteBuffer.Length);
anotherStream.Close();

' Create the printer server and print queue objects
Dim localPrintServer2 As New LocalPrintServer()
Dim defaultPrintQueue2 As PrintQueue = LocalPrintServer.GetDefaultPrintQueue()

' Call AddJob 
Dim anotherPrintJob As PrintSystemJobInfo = defaultPrintQueue2.AddJob("MyJob")

' Read a file into a StreamReader
Dim myStreamReader As New StreamReader("C:\test.txt")

' Write a Byte buffer to the JobStream and close the stream
Dim anotherStream As Stream = anotherPrintJob.JobStream
Dim anotherByteBuffer() As Byte = UnicodeEncoding.Unicode.GetBytes(myStreamReader.ReadToEnd())
anotherStream.Write(anotherByteBuffer, 0, anotherByteBuffer.Length)
anotherStream.Close()

Hinweise

Achtung

Gilt für:

Teilen über

PrintQueue.AddJob Methode

Definition

Überlädt

Hinweise

AddJob(String, String, Boolean, PrintTicket)

Parameter

Gibt zurück

Hinweise

Gilt für:

AddJob(String, PrintTicket)

Parameter

Gibt zurück

Hinweise

Gilt für:

AddJob(String, String, Boolean)

Parameter

Gibt zurück

Beispiele

Hinweise

Weitere Informationen

Gilt für:

AddJob()

Gibt zurück

Beispiele

Hinweise

Gilt für:

AddJob(String)

Parameter

Gibt zurück

Beispiele

Hinweise

Gilt für:

Zusätzliche Ressourcen