PrintQueue.AddJob Méthode

Définition

Espace de noms:: System.Printing

Assembly:: System.Printing.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Insère un nouveau travail d’impression dans la file d’attente.

Surcharges

Nom	Description
AddJob(String, String, Boolean, PrintTicket)	Insère un nouveau travail d’impression pour un document XPS (XML Paper Specification) dans la file d’attente, lui donne le nom et les paramètres spécifiés et spécifie s’il doit être validé ou non.
AddJob(String, PrintTicket)	Insère un nouveau travail d’impression pour un document XPS (XML Paper Specification) dans la file d’attente et lui donne le nom et les paramètres spécifiés.
AddJob(String, String, Boolean)	Insère un nouveau travail d’impression pour un document XPS (XML Paper Specification) dans la file d’attente, lui donne le nom spécifié et spécifie s’il doit être validé ou non.
AddJob()	Insère un nouveau travail d’impression (génériquement nommé), dont le contenu est un Byte tableau, dans la file d’attente.
AddJob(String)	Insère un nouveau travail d’impression, dont le contenu est un Byte tableau, dans la file d’attente.

Remarques

Sauf si la file d’attente est suspendue ou dans un état d’erreur, le travail s’imprime lorsqu’il atteint le haut de la file d’attente. Il s’agit donc d’une fonction d’impression.

D’autres façons d’imprimer dans Windows Presentation Foundation (WPF) incluent la PrintDialog.PrintDocument méthode, qui peut être utilisée avec ou sans ouvrir la boîte de dialogue, et les nombreuses Write et WriteAsync méthodes du XpsDocumentWriter.

AddJob(String, String, Boolean, PrintTicket)

Insère un nouveau travail d’impression pour un document XPS (XML Paper Specification) dans la file d’attente, lui donne le nom et les paramètres spécifiés et spécifie s’il doit être validé ou non.

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

Paramètres

jobName: String

Chemin d’accès et nom du document en cours d’impression.

documentPath: String

Chemin d’accès et nom du document en cours d’impression.

fastCopy: Boolean

true pour spoolr rapidement sans commentaires de progression de page par page et sans valider que le fichier est valide XPS ; sinon, false.

printTicket: PrintTicket

Paramètres du travail d’impression.

Retours

PrintSystemJobInfo

Qui PrintSystemJobInfo représente le travail d’impression et son état.

Remarques

Pour plus d’informations, consultez AddJob(String, String, Boolean).

S’applique à

AddJob(String, PrintTicket)

Insère un nouveau travail d’impression pour un document XPS (XML Paper Specification) dans la file d’attente et lui donne le nom et les paramètres spécifiés.

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

Paramètres

jobName: String

Chemin d’accès et nom du document en cours d’impression.

printTicket: PrintTicket

Paramètres du travail d’impression.

Retours

PrintSystemJobInfo

Qui PrintSystemJobInfo représente le travail d’impression et son état.

Remarques

Pour plus d’informations, consultez AddJob(String).

S’applique à

AddJob(String, String, Boolean)

Insère un nouveau travail d’impression pour un document XPS (XML Paper Specification) dans la file d’attente, lui donne le nom spécifié et spécifie s’il doit être validé ou non.

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

Paramètres

jobName: String

Nom du travail d’impression.

documentPath: String

Chemin d’accès et nom du document en cours d’impression.

fastCopy: Boolean

true pour spoolr rapidement sans commentaires de progression de page par page et sans valider que le fichier est valide XPS ; sinon, false.

Retours

PrintSystemJobInfo

Qui PrintSystemJobInfo représente le travail d’impression et son état.

Exemples

L’exemple suivant montre comment utiliser AddJob(String, String, Boolean) pour imprimer par lots tous les fichiers XPS (XML Paper Specification) dans un répertoire.

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

Remarques

Si fastCopy c’est truele cas, l’imprimante doit être une vue d’ensemble de l’impression. Si ce n’est pas le cas, la AddJob(String, String, Boolean) méthode lève une exception.

Si fastCopy c’est falsele cas, il n’est pas nécessaire d’utiliser une imprimante XPSDrv. Le fichier XPS ajouté à la file d’attente est converti en langage de description de page de l’imprimante, tel que PCL ou Postscript. Toutefois, ce type d’impression effectue un appel au modèle objet de composant (COM). L’appel à COM nécessite que le thread appelant dispose d’un appartement à thread unique (STA) au lieu d’un appartement à plusieurs threads (MTA), qui est la valeur par défaut. Il existe deux façons de procéder :

La façon la plus simple consiste à ajouter le STAThreadAttribute (autrement dit, «[System.STAThreadAttribute()] ») juste au-dessus de la première ligne de la méthode de Main l’application (généralement «static void Main(string[] args) »).
Si vous avez besoin que l’état d’appartement de votre Main thread soit MTA, vous pouvez héberger l’appel dans AddJob(String, String, Boolean) un thread distinct dont l’état de l’appartement est défini STA avec SetApartmentState. L’exemple ci-dessous illustre cette deuxième technique.

Note

Vous ne pouvez pas appliquer la STAThreadAttribute méthode à n’importe quelle méthode, sauf Main que vous ne pouvez pas utiliser SetApartmentState pour le Main thread.

Voir aussi

S’applique à

AddJob()

Insère un nouveau travail d’impression (génériquement nommé), dont le contenu est un Byte tableau, dans la file d’attente.

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

public System.Printing.PrintSystemJobInfo AddJob();

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

Public Function AddJob () As PrintSystemJobInfo

Retours

PrintSystemJobInfo

Qui PrintSystemJobInfo représente le travail d’impression et son état.

Exemples

L’exemple suivant montre comment utiliser AddJob() pour envoyer un Byte tableau à une file d’attente d’impression. Ce code fonctionne uniquement avec les imprimantes qui peuvent détecter et imprimer du texte brut. Certains d’entre eux ne peuvent pas.

// 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()

Remarques

Utilisez cette méthode pour écrire des informations spécifiques à l’appareil, dans un fichier depool, qui n’est pas automatiquement inclus par le spouleur Microsoft Windows. Bien sûr, vous devez savoir si le fichier de spoulage est un métafichier amélioré (EMF) ou une spécification de papier XML (XPS). Si vous préférez utiliser l’API Stream , vous pouvez utiliser la PrintQueueStream classe au lieu de cette méthode.

Une fois la AddJob méthode appelée, vous devez écrire un Byte tableau dans la JobStream propriété du PrintSystemJobInfo travail d’impression retourné par AddJob ou aucun travail d’impression. Ce tableau est ce qui s’imprime si l’imprimante fonctionne et n’est pas suspendue.

Avertissement

Si le JobStream thread n’est pas fermé avant Close la fin du thread dans lequel AddJob il est appelé, il InvalidOperationException est levée lorsque ce thread se termine, car le thread du spouleur ne peut pas obtenir le contrôle sur l’objet Stream .

Dans l’interface utilisateur graphique de la file d’attente d’impression, le travail porte le nom « Imprimer le document système ». Pour donner au travail un nom différent, utilisez la AddJob(String) surcharge.

S’applique à

AddJob(String)

Insère un nouveau travail d’impression, dont le contenu est un Byte tableau, dans la file d’attente.

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

Paramètres

jobName: String

Nom du travail d’impression.

Retours

PrintSystemJobInfo

Qui PrintSystemJobInfo représente le travail d’impression et son état.

Exemples

L’exemple suivant montre comment lire AddJob(String) un fichier dans un Byte tableau et envoyer le tableau à une file d’attente d’impression. Ce code suppose qu’il existe un fichier appelé test.txt à la racine du lecteur C : . Ce code fonctionne uniquement avec les imprimantes qui peuvent détecter et imprimer du texte brut. Certains d’entre eux ne peuvent pas.

// 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()

Remarques

Avertissement

S’applique à

Commentaires

Cette page a-t-elle été utile ?

Partager via

PrintQueue.AddJob Méthode

Définition

Surcharges

Remarques

AddJob(String, String, Boolean, PrintTicket)

Paramètres

Retours

Remarques

S’applique à

AddJob(String, PrintTicket)

Paramètres

Retours

Remarques

S’applique à

AddJob(String, String, Boolean)

Paramètres

Retours

Exemples

Remarques

Voir aussi

S’applique à

AddJob()

Retours

Exemples

Remarques

S’applique à

AddJob(String)

Paramètres

Retours

Exemples

Remarques

S’applique à

Commentaires