PrintQueue.AddJob Метод

Ссылка

Определение

Пространство имен:: System.Printing

Сборка:: System.Printing.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Вставляет новое задание печати в очередь.

Перегрузки

AddJob(String, String, Boolean, PrintTicket)	Вставляет новое задание печати для документа XPS в очередь, присваивает ему указанное имя и параметры, а также указывает, следует ли проверять документ.
AddJob(String, PrintTicket)	Вставляет новое задание печати для документа XPS в очередь и присваивает ему указанное имя и параметры.
AddJob(String, String, Boolean)	Вставляет новое задание печати для документа XPS в очередь, присваивает ему указанное имя и указывает, следует ли проверять документ.
AddJob()	Вставляет в очередь новое задание печати (с общим именем), содержимое которого является массивом типа Byte.
AddJob(String)	Вставляет в очередь новое задание печати, содержимое которого является массивом типа Byte.

Другие способы печати в Windows Presentation Foundation (WPF) включают PrintDialog.PrintDocument метод , который можно использовать с открытием диалогового окна или без него, а также множество Write методов XpsDocumentWriterи WriteAsync .

AddJob(String, String, Boolean, PrintTicket)

Вставляет новое задание печати для документа XPS в очередь, присваивает ему указанное имя и параметры, а также указывает, следует ли проверять документ.

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

Параметры

jobName: String

Путь и имя печатаемого документа.

documentPath: String

Путь и имя печатаемого документа.

fastCopy: Boolean

true быстрое заполнение без обратной связи о ходе выполнения по страницам и без проверки допустимости файла XPS; в противном случае — false.

printTicket: PrintTicket

Параметры задания печати.

Возвращаемое значение

PrintSystemJobInfo

Объект PrintSystemJobInfo, представляющий задание печати и его состояние.

Применяется к

AddJob(String, PrintTicket)

Вставляет новое задание печати для документа XPS в очередь и присваивает ему указанное имя и параметры.

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

Параметры

jobName: String

Путь и имя печатаемого документа.

printTicket: PrintTicket

Параметры задания печати.

Возвращаемое значение

PrintSystemJobInfo

Объект PrintSystemJobInfo, представляющий задание печати и его состояние.

Применяется к

AddJob(String, String, Boolean)

Вставляет новое задание печати для документа XPS в очередь, присваивает ему указанное имя и указывает, следует ли проверять документ.

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

Параметры

jobName: String

Имя задания печати.

documentPath: String

Путь и имя печатаемого документа.

fastCopy: Boolean

Возвращаемое значение

PrintSystemJobInfo

Объект PrintSystemJobInfo, представляющий задание печати и его состояние.

Примеры

В следующем примере показано, как использовать AddJob(String, String, Boolean) для пакетной печати всех 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();
    }
}

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

Если fastCopy имеет значение false, то нет необходимости использовать принтер XPSDrv. XPS-файл, добавляемый в очередь, преобразуется в язык описания страницы принтера, например PCL или Postscript. Однако этот тип печати вызывает компонентную объектную модель (COM). Для вызова COM требуется, чтобы вызывающий поток был однопотоковый объект (STA), а не многопоточный объект (MTA), который используется по умолчанию в Microsoft .NET 2.0 и более поздних версиях. (Дополнительные сведения о потоках и состояниях квартир см. в разделах Управляемые и неуправляемые потоки и ApartmentState.) Это можно сделать двумя способами.

Самый простой способ — добавить STAThreadAttribute (т. е. "[System.STAThreadAttribute()]") непосредственно над первой строкой метода приложения Main (обычно "static void Main(string[] args)").
Если требуется, чтобы состояние квартиры потока Main было MTA, вызов можно разместить AddJob(String, String, Boolean) в отдельном потоке, для которого задано STA SetApartmentStateзначение . В приведенном ниже примере показан второй метод.

Примечание

Нельзя применить к какому-либо методу STAThreadAttribute , за исключением Main и нельзя использовать SetApartmentState для Main потока.

См. также раздел

Применяется к

AddJob()

Вставляет в очередь новое задание печати (с общим именем), содержимое которого является массивом типа Byte.

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

public System.Printing.PrintSystemJobInfo AddJob ();

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

Public Function AddJob () As PrintSystemJobInfo

Возвращаемое значение

PrintSystemJobInfo

Объект PrintSystemJobInfo, представляющий задание печати и его состояние.

Примеры

В следующем примере показано, как использовать AddJob() для отправки массива Byte в очередь печати. Этот код работает только с принтерами, которые могут обнаруживать и печатать обычный текст. Некоторые из них не могут.

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

Используйте этот метод для записи сведений об устройстве в файл очереди, который автоматически не включается в очередь очереди печати Microsoft Windows. Конечно, необходимо знать, является ли файл очереди расширенным метафайлом (EMF) или спецификацией XML-бумаги (XPS). Если вы предпочитаете Stream работать с API, вместо этого метода можно использовать PrintQueueStream класс .

AddJob После вызова метода необходимо записать Byte массив в JobStream свойство PrintSystemJobInfo объекта , возвращаемое методом AddJob , иначе задание печати не создается. Этот массив печатается, если принтер работает и не приостановлен.

Внимание!

JobStream Если не закрывается с Close до конца потока, в котором AddJob вызывается, то при завершении этого потока создается исключение , InvalidOperationException так как поток очереди очереди не может получить контроль над Stream объектом .

В графическом пользовательском интерфейсе очереди печати задание имеет имя "Печать системного документа". Чтобы присвоить заданию другое имя, используйте перегрузку AddJob(String) .

Применяется к

AddJob(String)

Вставляет в очередь новое задание печати, содержимое которого является массивом типа Byte.

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

Параметры

jobName: String

Имя задания печати.

Возвращаемое значение

PrintSystemJobInfo

Объект PrintSystemJobInfo, представляющий задание печати и его состояние.

Примеры

В следующем примере показано, как использовать AddJob(String) для чтения файла в Byte массив и отправки массива в очередь печати. В этом коде предполагается, что в корне диска C: есть файл с именем test.txt. Этот код работает только с принтерами, которые могут обнаруживать и печатать обычный текст. Некоторые из них не могут.

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

Применяется к

PrintQueue.AddJob Метод

Определение

Перегрузки

Комментарии

AddJob(String, String, Boolean, PrintTicket)

Параметры

Возвращаемое значение

Комментарии

Применяется к

AddJob(String, PrintTicket)

Параметры

Возвращаемое значение

Комментарии

Применяется к

AddJob(String, String, Boolean)

Параметры

Возвращаемое значение

Примеры

Комментарии

См. также раздел

Применяется к

AddJob()

Возвращаемое значение

Примеры

Комментарии

Применяется к

AddJob(String)

Параметры

Возвращаемое значение

Примеры

Комментарии

Применяется к

Обратная связь

Дополнительные ресурсы