PrintQueue::MergeAndValidatePrintTicket Method (PrintTicket^, PrintTicket^)

 

Merges two PrintTickets and guarantees that the resulting PrintTicket is valid and does not ask for any printing functionality that the printer does not support.

Namespace:   System.Printing
Assembly:  System.Printing (in System.Printing.dll)

public:
ValidationResult MergeAndValidatePrintTicket(
	PrintTicket^ basePrintTicket,
	PrintTicket^ deltaPrintTicket
)

Parameters

basePrintTicket
Type: System.Printing::PrintTicket^

The first print ticket.

deltaPrintTicket
Type: System.Printing::PrintTicket^

The second print ticket. This can be null.

Return Value

Type: System.Printing::ValidationResult

A ValidationResult that includes the merged PrintTicket and an indication of whether any of its settings had to be changed to guarantee viability.

Exception Condition
ArgumentException

At least one of the input print tickets is not valid.

ArgumentNullException

The basePrintTicket is null.

PrintQueueException

The validation, merger, and viability checking operation failed.

The method produces a viable print ticket; that is, a ticket that does not request printing features that the printer does not support. The method first validates the two input print tickets against the Print Schema. If either is invalid, an exception is thrown.

The two tickets are then merged. If they have different values for a particular property then the resulting merged ticket initially uses the value of the delta ticket.

The merged ticket is then checked against the actual capabilities of the printer. If any settings in the ticket are incompatible with the printer's capabilities, then the printer driver changes those settings by using whatever logic it wants. Typically, it substitutes the user's or printer's default value for the setting. It the driver's source of substitute values is not the same ticket as basePrintTicket, then the merged ticket might have some settings that are different from both of the input tickets. If the printer driver has to change any settings then this fact is reported in the ConflictStatus property of the ValidationResult.

To merge and validate based on a print queue’s default settings, you should set basePrintTicket to the DefaultPrintTicket or the UserPrintTicket.

The deltaPrintTicket parameter can be null, in which case the basePrintTicket is validated, checked for viability, and returned, possibly with changes.

With this overload of MergeAndValidatePrintTicket, both the deltaPrintTicket and the PrintTicket in the ValidationResult that is returned have job wide scope. To specify a different scope use the other overload of this method.

The following example shows how to use this method to merge two print tickets and respond to the ValidationResult that is returned.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top
Show: