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。 这表示打印目标支持功能，但当前所选内容对此打印机是自定义的。 例如，打印目标可能支持一种特殊的方法来绑定不是标准值之一的文档。 在这种情况下，对 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)	检索打印页的物理尺寸和格式设置数据。

另请参阅

• PrintColorMode
• PrintMediaSize
• StandardPrintTaskOptions