PrintQueue.MergeAndValidatePrintTicket Méthode

Définition

Espace de noms:

System.Printing

Assembly:

System.Printing.dll

Fusionne deux PrintTicket et garantit que le PrintTicket résultant est valide et ne demande pas de fonctionnalité d'impression non prise en charge par l'imprimante.

Surcharges

MergeAndValidatePrintTicket(PrintTicket, PrintTicket)	Fusionne deux PrintTicket et garantit que le PrintTicket résultant est valide et ne demande pas de fonctionnalité d'impression non prise en charge par l'imprimante.
MergeAndValidatePrintTicket(PrintTicket, PrintTicket, PrintTicketScope)	Fusionne deux PrintTicket et garantit que le PrintTicket résultant est valide, ne demande pas de fonctionnalité d'impression non prise en charge par l'imprimante et se limite à la portée spécifiée.

MergeAndValidatePrintTicket(PrintTicket, PrintTicket)

Fusionne deux PrintTicket et garantit que le PrintTicket résultant est valide et ne demande pas de fonctionnalité d'impression non prise en charge par l'imprimante.

public:
 System::Printing::ValidationResult MergeAndValidatePrintTicket(System::Printing::PrintTicket ^ basePrintTicket, System::Printing::PrintTicket ^ deltaPrintTicket);

public System.Printing.ValidationResult MergeAndValidatePrintTicket (System.Printing.PrintTicket basePrintTicket, System.Printing.PrintTicket deltaPrintTicket);

member this.MergeAndValidatePrintTicket : System.Printing.PrintTicket * System.Printing.PrintTicket -> System.Printing.ValidationResult

Public Function MergeAndValidatePrintTicket (basePrintTicket As PrintTicket, deltaPrintTicket As PrintTicket) As ValidationResult

Paramètres

basePrintTicket

PrintTicket

Premier ticket d'impression.

deltaPrintTicket

PrintTicket

Deuxième ticket d'impression. Il peut s’agir de null.

Retours

ValidationResult

ValidationResult qui inclut les PrintTicket fusionnés et une indication sur la nécessité d'avoir eu ou non à en modifier des paramètres pour en garantir la viabilité.

Exceptions

ArgumentException

Au moins l'un des tickets d'impression d'entrée n'est pas valide.

ArgumentNullException

basePrintTicket a la valeur null.

PrintQueueException

Échec de la validation, de la fusion et de la vérification de la viabilité.

Exemples

L’exemple suivant montre comment utiliser cette méthode pour fusionner deux tickets d’impression et répondre au ValidationResult qui est retourné.

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

Remarques

La méthode produit un ticket d’impression viable ; autrement dit, un ticket qui ne demande pas de fonctionnalités d’impression que l’imprimante ne prend pas en charge. La méthode valide d’abord les deux tickets d’impression d’entrée par rapport au schéma d’impression. Si l’un ou l’autre n’est pas valide, une exception est levée.

Les deux tickets sont ensuite fusionnés. S’ils ont des valeurs différentes pour une propriété particulière, le ticket fusionné résultant utilise initialement la valeur du ticket delta.

Le ticket fusionné est ensuite vérifié par rapport aux fonctionnalités réelles de l’imprimante. Si les paramètres du ticket sont incompatibles avec les fonctionnalités de l’imprimante, le pilote d’imprimante les modifie à l’aide de la logique souhaitée. En règle générale, il substitue la valeur par défaut de l’utilisateur ou de l’imprimante au paramètre. La source de valeurs de substitution du pilote n’est pas le même ticket que basePrintTicket, alors le ticket fusionné peut avoir certains paramètres qui sont différents des deux tickets d’entrée. Si le pilote d’imprimante doit modifier des paramètres, ce fait est signalé dans la ConflictStatus propriété du ValidationResult.

Pour fusionner et valider en fonction des paramètres par défaut d’une file d’attente d’impression, vous devez définir basePrintTicket sur DefaultPrintTicket ou le UserPrintTicket.

Le deltaPrintTicket paramètre peut être null, auquel cas le basePrintTicket est validé, vérifié pour la viabilité et retourné, éventuellement avec des modifications.

Avec cette surcharge de MergeAndValidatePrintTicket, le deltaPrintTicket et dans PrintTicket le qui est retourné ont une ValidationResult étendue de travail large. Pour spécifier une autre étendue, utilisez l’autre surcharge de cette méthode.

MergeAndValidatePrintTicket(PrintTicket, PrintTicket, PrintTicketScope)

Fusionne deux PrintTicket et garantit que le PrintTicket résultant est valide, ne demande pas de fonctionnalité d'impression non prise en charge par l'imprimante et se limite à la portée spécifiée.

public:
 System::Printing::ValidationResult MergeAndValidatePrintTicket(System::Printing::PrintTicket ^ basePrintTicket, System::Printing::PrintTicket ^ deltaPrintTicket, System::Printing::PrintTicketScope scope);

public System.Printing.ValidationResult MergeAndValidatePrintTicket (System.Printing.PrintTicket basePrintTicket, System.Printing.PrintTicket deltaPrintTicket, System.Printing.PrintTicketScope scope);

member this.MergeAndValidatePrintTicket : System.Printing.PrintTicket * System.Printing.PrintTicket * System.Printing.PrintTicketScope -> System.Printing.ValidationResult

Public Function MergeAndValidatePrintTicket (basePrintTicket As PrintTicket, deltaPrintTicket As PrintTicket, scope As PrintTicketScope) As ValidationResult

Paramètres

basePrintTicket

PrintTicket

Premier ticket d'impression.

deltaPrintTicket

PrintTicket

Deuxième ticket d'impression. Il peut s’agir de null.

scope

PrintTicketScope

Valeur qui indique si la portée du deltaPrintTicket et la portée du ticket d'impression retourné dans le ValidationResult, est une page, un document ou l'intégralité du travail.

Retours

ValidationResult

ValidationResult qui inclut les PrintTicket fusionnés et une indication sur la nécessité d'avoir eu ou non à en modifier des paramètres pour en garantir la viabilité.

Exceptions

ArgumentException

Au moins l'un des tickets d'impression d'entrée n'est pas valide.

ArgumentNullException

basePrintTicket a la valeur null.

ArgumentOutOfRangeException

Le paramètre scope n'a pas une valeur PrintTicketScope valide.

PrintQueueException

Échec de la validation, de la fusion et de la vérification de la viabilité.

Remarques

La méthode produit un ticket d’impression viable ; autrement dit, un ticket qui ne demande pas de fonctionnalités d’impression que l’imprimante ne prend pas en charge. La méthode valide d’abord les deux tickets d’impression d’entrée par rapport au schéma d’impression. Si l’un ou l’autre n’est pas valide, une exception est levée.

Les deux tickets sont ensuite fusionnés. S’ils ont des valeurs différentes pour une propriété particulière, le ticket fusionné résultant utilise initialement la valeur du ticket delta.

Le ticket fusionné est ensuite vérifié par rapport aux fonctionnalités réelles de l’imprimante. Si les paramètres du ticket sont incompatibles avec les fonctionnalités de l’imprimante, le pilote d’imprimante les modifie à l’aide de la logique souhaitée. En règle générale, il substitue la valeur par défaut de l’utilisateur ou de l’imprimante au paramètre. La source de valeurs de substitution du pilote n’est pas le même ticket que basePrintTicket, alors le ticket fusionné peut avoir certains paramètres qui sont différents des deux tickets d’entrée. Si le pilote d’imprimante doit modifier des paramètres, ce fait est signalé dans la ConflictStatus propriété du ValidationResult.

Pour fusionner et valider en fonction des paramètres par défaut d’une file d’attente d’impression, vous devez définir basePrintTicket sur DefaultPrintTicket ou le UserPrintTicket.

Le deltaPrintTicket paramètre peut être null, auquel cas le basePrintTicket est validé, vérifié pour la viabilité et retourné, éventuellement avec des modifications.

S’il scope s’agit d’un travail, le ticket d’impression retourné dans peut ValidationResult inclure des paramètres de schéma d’impression avec les préfixes Travail, Document et Page. Si est scope un document, les paramètres par travail dans deltaPrintTicket sont ignorés, et le ticket retourné peut inclure des paramètres avec des préfixes Document et Page. S’il scope s’agit d’une page, les paramètres par travail et les paramètres par document dans deltaPrintTicket sont ignorés, et le ticket retourné peut inclure des paramètres avec uniquement le préfixe Page.