Delen via

Hoe te: PrintTickets valideren en samenvoegen

Het Microsoft Windows Print Schema bevat de flexibele en uitbreidbare PrintCapabilities en PrintTicket elementen. In het vorige artikel worden de mogelijkheden van een afdrukapparaat beschreven en de laatste geeft aan hoe het apparaat deze mogelijkheden moet gebruiken met betrekking tot een bepaalde reeks documenten, afzonderlijke documenten of afzonderlijke pagina's.

Een typische reeks taken voor een toepassing die afdrukken ondersteunt, is als volgt.

  1. De mogelijkheden van een printer bepalen.

  2. Configureer een PrintTicket om deze mogelijkheden te gebruiken.

  3. Valideer de PrintTicket.

In dit artikel wordt beschreven hoe u dit doet.

Voorbeeld

In het onderstaande eenvoudige voorbeeld zijn we alleen geïnteresseerd in of een printer dubbelzijdig afdrukken kan ondersteunen. De belangrijkste stappen zijn als volgt.

  1. Haal een PrintCapabilities-object op met de methode GetPrintCapabilities.

  2. Test op de aanwezigheid van de gewenste mogelijkheid. In het onderstaande voorbeeld testen we de eigenschap DuplexingCapability van het PrintCapabilities-object om te zien of er de mogelijkheid is om aan beide zijden van een vel papier af te drukken, waarbij het paginaomslag langs de lange zijde van het vel plaatsvindt. Omdat DuplexingCapability een verzameling is, gebruiken we de Contains methode van ReadOnlyCollection<T>.

    Opmerking

    Deze stap is niet strikt noodzakelijk. De MergeAndValidatePrintTicket methode die hieronder wordt gebruikt, controleert elke aanvraag in de PrintTicket op basis van de mogelijkheden van de printer. Als de aangevraagde mogelijkheid niet wordt ondersteund door de printer, vervangt het printerstuurprogramma een alternatieve aanvraag in de PrintTicket geretourneerd door de methode.

  3. Als de printer dubbelzijdig afdrukken ondersteunt, maakt de voorbeeldcode een PrintTicket die dubbelzijdig afdrukken aanvraagt. Maar de toepassing geeft niet elke mogelijke printerinstelling op die beschikbaar is in het PrintTicket element. Dat zou verspilling zijn van zowel programmeur als programmatijd. In plaats daarvan stelt de code alleen de aanvraag voor dubbelzijdig afdrukken in en voegt het vervolgens PrintTicket samen met een bestaande, volledig geconfigureerde en gevalideerde PrintTicket, in dit geval de standaardinstelling PrintTicketvan de gebruiker.

  4. Daarom roept het voorbeeld de MergeAndValidatePrintTicket methode aan om de nieuwe, minimale PrintTicket samen te voegen met de standaard-PrintTicketvan de gebruiker. Hiermee wordt een ValidationResult geretourneerd die de nieuwe PrintTicket als een van de eigenschappen bevat.

  5. Het voorbeeld test vervolgens dat de nieuwe PrintTicket dubbelzijdige gegevens aanvraagt. Als dit het geval is, wordt in het voorbeeld het nieuwe standaardafdrukticket voor de gebruiker gemaakt. Als stap 2 hierboven was weggelaten en de printer geen ondersteuning bood voor dubbelzijdig afdrukken aan de lange kant, zou de test hebben geresulteerd in false. (Zie de bovenstaande opmerking.)

  6. De laatste belangrijke stap is het doorvoeren van de wijziging in de eigenschap UserPrintTicket van de PrintQueue met de methode Commit.

/// <summary>
/// Changes the user-default PrintTicket setting of the specified print queue.
/// </summary>
/// <param name="queue">the printer whose user-default PrintTicket setting needs to be changed</param>
static private void ChangePrintTicketSetting(PrintQueue queue)
{
    //
    // Obtain the printer's PrintCapabilities so we can determine whether or not
    // duplexing printing is supported by the printer.
    //
    PrintCapabilities printcap = queue.GetPrintCapabilities();

    //
    // The printer's duplexing capability is returned as a read-only collection of duplexing options
    // that can be supported by the printer. If the collection returned contains the duplexing
    // option we want to set, it means the duplexing option we want to set is supported by the printer,
    // so we can make the user-default PrintTicket setting change.
    //
    if (printcap.DuplexingCapability.Contains(Duplexing.TwoSidedLongEdge))
    {
        //
        // To change the user-default PrintTicket, we can first create a delta PrintTicket with
        // the new duplexing setting.
        //
        PrintTicket deltaTicket = new PrintTicket();
        deltaTicket.Duplexing = Duplexing.TwoSidedLongEdge;

        //
        // Then merge the delta PrintTicket onto the printer's current user-default PrintTicket,
        // and validate the merged PrintTicket to get the new PrintTicket we want to set as the
        // printer's new user-default PrintTicket.
        //
        ValidationResult result = queue.MergeAndValidatePrintTicket(queue.UserPrintTicket, deltaTicket);

        //
        // The duplexing option we want to set could be constrained by other PrintTicket settings
        // or device settings. We can check the validated merged PrintTicket to see whether the
        // the validation process has kept the duplexing option we want to set unchanged.
        //
        if (result.ValidatedPrintTicket.Duplexing == Duplexing.TwoSidedLongEdge)
        {
            //
            // Set the printer's user-default PrintTicket and commit the set operation.
            //
            queue.UserPrintTicket = result.ValidatedPrintTicket;
            queue.Commit();
            Console.WriteLine("PrintTicket new duplexing setting is set on '{0}'.", queue.FullName);
        }
        else
        {
            //
            // The duplexing option we want to set has been changed by the validation process
            // when it was resolving setting constraints.
            //
            Console.WriteLine("PrintTicket new duplexing setting is constrained on '{0}'.", queue.FullName);
        }
    }
    else
    {
        //
        // If the printer doesn't support the duplexing option we want to set, skip it.
        //
        Console.WriteLine("PrintTicket new duplexing setting is not supported on '{0}'.", queue.FullName);
    }
}

''' <summary>
''' Changes the user-default PrintTicket setting of the specified print queue.
''' </summary>
''' <param name="queue">the printer whose user-default PrintTicket setting needs to be changed</param>
Private Shared Sub ChangePrintTicketSetting(ByVal queue As PrintQueue)
    '
    ' Obtain the printer's PrintCapabilities so we can determine whether or not
    ' duplexing printing is supported by the printer.
    '
    Dim printcap As PrintCapabilities = queue.GetPrintCapabilities()

    '
    ' The printer's duplexing capability is returned as a read-only collection of duplexing options
    ' that can be supported by the printer. If the collection returned contains the duplexing
    ' option we want to set, it means the duplexing option we want to set is supported by the printer,
    ' so we can make the user-default PrintTicket setting change.
    '
    If printcap.DuplexingCapability.Contains(Duplexing.TwoSidedLongEdge) Then
        '
        ' To change the user-default PrintTicket, we can first create a delta PrintTicket with
        ' the new duplexing setting.
        '
        Dim deltaTicket As New PrintTicket()
        deltaTicket.Duplexing = Duplexing.TwoSidedLongEdge

        '
        ' Then merge the delta PrintTicket onto the printer's current user-default PrintTicket,
        ' and validate the merged PrintTicket to get the new PrintTicket we want to set as the
        ' printer's new user-default PrintTicket.
        '
        Dim result As ValidationResult = queue.MergeAndValidatePrintTicket(queue.UserPrintTicket, deltaTicket)

        '
        ' The duplexing option we want to set could be constrained by other PrintTicket settings
        ' or device settings. We can check the validated merged PrintTicket to see whether the
        ' the validation process has kept the duplexing option we want to set unchanged.
        '
        If result.ValidatedPrintTicket.Duplexing = Duplexing.TwoSidedLongEdge Then
            '
            ' Set the printer's user-default PrintTicket and commit the set operation.
            '
            queue.UserPrintTicket = result.ValidatedPrintTicket
            queue.Commit()
            Console.WriteLine("PrintTicket new duplexing setting is set on '{0}'.", queue.FullName)
        Else
            '
            ' The duplexing option we want to set has been changed by the validation process
            ' when it was resolving setting constraints.
            '
            Console.WriteLine("PrintTicket new duplexing setting is constrained on '{0}'.", queue.FullName)
        End If
    Else
        '
        ' If the printer doesn't support the duplexing option we want to set, skip it.
        '
        Console.WriteLine("PrintTicket new duplexing setting is not supported on '{0}'.", queue.FullName)
    End If
End Sub

Zodat u dit voorbeeld snel kunt testen, wordt de rest van het voorbeeld hieronder weergegeven. Maak een project en een naamruimte en plak vervolgens beide codefragmenten in dit artikel in het naamruimteblok.

/// <summary>
/// Displays the correct command line syntax to run this sample program.
/// </summary>
static private void DisplayUsage()
{
    Console.WriteLine();
    Console.WriteLine("Usage #1: printticket.exe -l \"<printer_name>\"");
    Console.WriteLine("      Run program on the specified local printer");
    Console.WriteLine();
    Console.WriteLine("      Quotation marks may be omitted if there are no spaces in printer_name.");
    Console.WriteLine();
    Console.WriteLine("Usage #2: printticket.exe -r \"\\\\<server_name>\\<printer_name>\"");
    Console.WriteLine("      Run program on the specified network printer");
    Console.WriteLine();
    Console.WriteLine("      Quotation marks may be omitted if there are no spaces in server_name or printer_name.");
    Console.WriteLine();
    Console.WriteLine("Usage #3: printticket.exe -a");
    Console.WriteLine("      Run program on all installed printers");
    Console.WriteLine();
}

[STAThread]
static public void Main(string[] args)
{
    try
    {
        if ((args.Length == 1) && (args[0] == "-a"))
        {
            //
            // Change PrintTicket setting for all local and network printer connections.
            //
            LocalPrintServer server = new LocalPrintServer();

            EnumeratedPrintQueueTypes[] queue_types = {EnumeratedPrintQueueTypes.Local,
                                                       EnumeratedPrintQueueTypes.Connections};

            //
            // Enumerate through all the printers.
            //
            foreach (PrintQueue queue in server.GetPrintQueues(queue_types))
            {
                //
                // Change the PrintTicket setting queue by queue.
                //
                ChangePrintTicketSetting(queue);
            }
        }//end if -a

        else if ((args.Length == 2) && (args[0] == "-l"))
        {
            //
            // Change PrintTicket setting only for the specified local printer.
            //
            LocalPrintServer server = new LocalPrintServer();
            PrintQueue queue = new PrintQueue(server, args[1]);
            ChangePrintTicketSetting(queue);
        }//end if -l

        else if ((args.Length == 2) && (args[0] == "-r"))
        {
            //
            // Change PrintTicket setting only for the specified remote printer.
            //
            String serverName = args[1].Remove(args[1].LastIndexOf(@"\"));
            String printerName = args[1].Remove(0, args[1].LastIndexOf(@"\")+1);
            PrintServer ps = new PrintServer(serverName);
            PrintQueue queue = new PrintQueue(ps, printerName);
            ChangePrintTicketSetting(queue);
         }//end if -r

        else
        {
            //
            // Unrecognized command line.
            // Show user the correct command line syntax to run this sample program.
            //
            DisplayUsage();
        }
    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
        Console.WriteLine(e.StackTrace);

        //
        // Show inner exception information if it's provided.
        //
        if (e.InnerException != null)
        {
            Console.WriteLine("--- Inner Exception ---");
            Console.WriteLine(e.InnerException.Message);
            Console.WriteLine(e.InnerException.StackTrace);
        }
    }
    finally
    {
        Console.WriteLine("Press Return to continue...");
        Console.ReadLine();
    }
}//end Main

''' <summary>
''' Displays the correct command line syntax to run this sample program.
''' </summary>
Private Shared Sub DisplayUsage()
    Console.WriteLine()
    Console.WriteLine("Usage #1: printticket.exe -l ""<printer_name>""")
    Console.WriteLine("      Run program on the specified local printer")
    Console.WriteLine()
    Console.WriteLine("      Quotation marks may be omitted if there are no spaces in printer_name.")
    Console.WriteLine()
    Console.WriteLine("Usage #2: printticket.exe -r ""\\<server_name>\<printer_name>""")
    Console.WriteLine("      Run program on the specified network printer")
    Console.WriteLine()
    Console.WriteLine("      Quotation marks may be omitted if there are no spaces in server_name or printer_name.")
    Console.WriteLine()
    Console.WriteLine("Usage #3: printticket.exe -a")
    Console.WriteLine("      Run program on all installed printers")
    Console.WriteLine()
End Sub


<STAThread>
Public Shared Sub Main(ByVal args() As String)
    Try
        If (args.Length = 1) AndAlso (args(0) = "-a") Then
            '
            ' Change PrintTicket setting for all local and network printer connections.
            '
            Dim server As New LocalPrintServer()

            Dim queue_types() As EnumeratedPrintQueueTypes = {EnumeratedPrintQueueTypes.Local, EnumeratedPrintQueueTypes.Connections}

            '
            ' Enumerate through all the printers.
            '
            For Each queue As PrintQueue In server.GetPrintQueues(queue_types)
                '
                ' Change the PrintTicket setting queue by queue.
                '
                ChangePrintTicketSetting(queue)
            Next queue 'end if -a

        ElseIf (args.Length = 2) AndAlso (args(0) = "-l") Then
            '
            ' Change PrintTicket setting only for the specified local printer.
            '
            Dim server As New LocalPrintServer()
            Dim queue As New PrintQueue(server, args(1))
            ChangePrintTicketSetting(queue) 'end if -l

        ElseIf (args.Length = 2) AndAlso (args(0) = "-r") Then
            '
            ' Change PrintTicket setting only for the specified remote printer.
            '
            Dim serverName As String = args(1).Remove(args(1).LastIndexOf("\"))
            Dim printerName As String = args(1).Remove(0, args(1).LastIndexOf("\")+1)
            Dim ps As New PrintServer(serverName)
            Dim queue As New PrintQueue(ps, printerName)
            ChangePrintTicketSetting(queue) 'end if -r

        Else
            '
            ' Unrecognized command line.
            ' Show user the correct command line syntax to run this sample program.
            '
            DisplayUsage()
        End If
    Catch e As Exception
        Console.WriteLine(e.Message)
        Console.WriteLine(e.StackTrace)

        '
        ' Show inner exception information if it's provided.
        '
        If e.InnerException IsNot Nothing Then
            Console.WriteLine("--- Inner Exception ---")
            Console.WriteLine(e.InnerException.Message)
            Console.WriteLine(e.InnerException.StackTrace)
        End If
    Finally
        Console.WriteLine("Press Return to continue...")
        Console.ReadLine()
    End Try
End Sub

Zie ook

  • Last updated on