方法 : PrintTickets を検証およびマージする
Microsoft Windows 印刷スキーマには、柔軟で拡張性に優れた PrintCapabilities 要素と PrintTicket 要素が含まれています。 前者は印刷デバイスの機能を明細化し、後者はデバイスが特定のドキュメントのシーケンス、個々のドキュメント、または個々のページに対してこれらの機能を使用する方法を指定します。
印刷をサポートするアプリケーションの一般的な一連のタスクは次のとおりです。
プリンターの機能を確認します。
その機能を使用するように PrintTicket を構成します。
PrintTicket を検証します。
この記事では、この実行方法を示します。
使用例
次の簡単な例では、プリンターで二面印刷 (両面印刷) がサポートされるかどうかにのみ焦点を当てています。 主な手順は次のとおりです。
GetPrintCapabilities メソッドを使用して、PrintCapabilities オブジェクトを取得します。
必要な機能が存在するかどうかをテストします。 次の例では、PrintCapabilities オブジェクトの DuplexingCapability プロパティをテストして、用紙の長辺に沿って "ページをめくり"、用紙の両面に印刷する機能が存在するかどうかを確認します。 DuplexingCapability はコレクションであるので、ReadOnlyCollection<T> の Contains メソッドを使用します。
メモ
この手順は、厳密には必要ありません。以下で使用される MergeAndValidatePrintTicket メソッドによって、PrintTicket の各要求がプリンターの機能と照合されます。要求された機能がプリンターでサポートされていない場合、プリンター ドライバーによってメソッドから返される PrintTicket の代替要求に置き換えられます。
プリンターで両面印刷がサポートされている場合、サンプル コードによって両面印刷を要求する PrintTicket が作成されます。 ただし、アプリケーションでは、PrintTicket 要素で使用可能なあらゆるプリンター設定が指定されるわけではありません。 プログラマとプログラムの時間の両方にとって無駄な処理となるためです。 代わりに、コードによって両面印刷要求のみが設定され、この PrintTicket と既存の完全に構成および検証された PrintTicket (この場合はユーザーの既定の PrintTicket) がマージされます。
したがって、サンプルによって MergeAndValidatePrintTicket メソッドが呼び出され、新しい最小限の PrintTicket とユーザーの既定の PrintTicket がマージされます。 これにより、新しい PrintTicket をプロパティの 1 つとして含む ValidationResult が返されます。
次に、サンプルによって新しい PrintTicket が両面印刷を要求するかどうかがテストされます。 要求する場合、その印刷チケットがユーザーの新しい既定の印刷チケットになります。 前の手順 2. を省略した場合、プリンターで長辺とじ両面印刷がサポートされないと、テストは false になります (上記のメモを参照してください)。
最後の重要な手順は、Commit メソッドを使用して、変更を PrintQueue の UserPrintTicket プロパティにコミットすることです。
''' <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
/// <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>
''' 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 'end Main
/// <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