PrintTaskOptions クラス

  • リファレンス

定義

名前空間:
Windows.Graphics.Printing
編集

コンテンツの印刷方法を定義するオプションを管理するためのメソッドとプロパティのコレクションを表します。

public ref class PrintTaskOptions sealed : IPrintTaskOptionsCore, IPrintTaskOptionsCoreProperties, IPrintTaskOptionsCoreUIConfiguration
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class PrintTaskOptions final : IPrintTaskOptionsCore, IPrintTaskOptionsCoreProperties, IPrintTaskOptionsCoreUIConfiguration
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class PrintTaskOptions : IPrintTaskOptionsCore, IPrintTaskOptionsCoreProperties, IPrintTaskOptionsCoreUIConfiguration
Public NotInheritable Class PrintTaskOptions
Implements IPrintTaskOptionsCore, IPrintTaskOptionsCoreProperties, IPrintTaskOptionsCoreUIConfiguration
継承
Object Platform::Object IInspectable PrintTaskOptions
属性
ContractVersionAttribute MarshalingBehaviorAttribute
実装
IPrintTaskOptionsCore IPrintTaskOptionsCoreProperties IPrintTaskOptionsCoreUIConfiguration

Windows の要件

デバイス ファミリ
Windows 10 (10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox で導入)
API contract
Windows.Foundation.UniversalApiContract (v1.0 で導入)

注釈

PrintTaskOptions クラスは、印刷時に印刷タスク内のコンテンツを書式設定する方法を定義するさまざまな値にアクセスできます。 PrintTaskOptions オブジェクトには、印刷されるページのサイズ、その向き、コンテンツを印刷するメディアの種類などの情報が含まれる場合があります。 さらに、PrintTaskOptions オブジェクトを使用すると、印刷ウィンドウに表示されるオプションの一覧にアクセスできます。

PrintTaskOptions の各オプション ( MediaSize や MediaType など) には、サポートされている値の特定のセットが含まれていますが、すべてのオプションは、一般的なケースを表すのと同じ一般的なパターンをサポートします。 一般的なケース値は 、Default、 NotAvailable 、 PrinterCustom です。

各オプションには既定値が含まれており、印刷先によってオプションに割り当てられる値です。 プロパティ アクセスを使用してこの値を取得する場合、印刷先がこのオプションの実際の値をまだ決定していないことを示します。 特定のオプションの既定値を設定すると、印刷先にそのオプションの既定値を使用する必要があることを示します。 そのオプションの既定値がない場合、オプション値は変更されません。

オプションでは、 NotAvailable 値を報告することもできます。 これは、現在選択されている印刷ターゲットに対して特定のオプションを使用できない場合を示します。 たとえば、Duplex プロパティが NotAvailable 値を返す場合、印刷先が双方向機能をサポートしていないことを示します。 オプションを NotAvailable 値に設定することはできません。

すべてのオプションに共通する最後の値は PrinterCustom です。 これは、印刷先が機能をサポートしているが、現在の選択がこのプリンターのカスタムであることを示します。 たとえば、印刷ターゲットは、標準値の 1 つではないドキュメントをバインドするための特別なメソッドをサポートする場合があります。 この場合、Binding オプションのプロパティ クエリは PrinterCustom 値を返します。 カスタム出力サイズも PrinterCustom 値として表されますが、実際の物理サイズは GetPageDescription メソッドを使用して引き続き使用できます。

アプリでは、PrintTaskOptions を使用して、印刷ウィンドウに表示されるオプションをカスタマイズすることもできます。 DisplayedOptions プロパティは、表示されるオプション項目の一覧を含むベクターを返します。 オプションの挿入、追加、削除、または並べ替えによるこのリストの変更は、印刷ウィンドウに反映されます。 特定の印刷先でオプションがサポートされていない場合、オプションはユーザーに表示されません。 標準オプションの名前については、「 StandardPrintTaskOptions」を参照してください。

印刷された出力を色に設定したり、印刷できるメディアのサイズを設定したりするために使用できるコード スニペットを次に示します。 オブジェクトには PrintTaskOptions 、 PrintTask.Options プロパティを使用してアクセスします。

// Set output to color
printTask.Options.ColorMode = PrintColorMode.Color;

// Set the media size for printing
printTask.Options.MediaSize = PrintMediaSize.NorthAmericaLegal;

これらの印刷タスク オプションに使用できる値の詳細については、「 PrintColorMode 」および「 PrintMediaSize」を参照してください。

バージョン履歴

Windows のバージョン SDK バージョン 追加された値
1607 14393 隣接
1607 14393 GetPagePrintTicket
1803 17134 CustomPageRanges
1803 17134 PageRangeOptions

プロパティ

Binding

印刷タスクのバインド オプションを取得または設定します。
Bordering

印刷タスクの罫線オプションを取得または設定します。
Collation

印刷タスクの照合順序オプションを取得または設定します。
ColorMode

印刷タスクのカラー モード オプションを取得または設定します。
CustomPageRanges

印刷タスクのカスタム ページ範囲オプションを取得します。
DisplayedOptions

印刷エクスペリエンスに表示されるオプションの一覧を取得します。
Duplex

印刷タスクの双方向オプションを取得または設定します。
HolePunch

印刷タスクの穴パンチング オプションを取得または設定します。
MaxCopies

印刷タスクでサポートされているコピーの最大数を取得します。
MediaSize

印刷タスクのメディア サイズ オプションを取得または設定します。
MediaType

印刷タスクのメディアの種類オプションを取得または設定します。
MinCopies

印刷タスクで許可される最小部数を取得します。
NumberOfCopies

印刷タスクのコピー数の値を取得または設定します。
Orientation

印刷タスクの方向オプションを取得または設定します。
PageRangeOptions

印刷タスクのページ範囲オプションを取得します。
PrintQuality

印刷タスクの印刷品質オプションを取得または設定します。
Staple

印刷タスクのステープル オプションを取得または設定します。

メソッド

GetPageDescription(UInt32)

印刷されたページの物理的な寸法を取得します。
GetPagePrintTicket(PrintPageInfo)

印刷されたページの物理的なディメンションと書式設定データを取得します。

適用対象

こちらもご覧ください