PrintHolePunchOptionDetails PrintHolePunchOptionDetails PrintHolePunchOptionDetails PrintHolePunchOptionDetails PrintHolePunchOptionDetails Class

Definition

Represents the list of punch hole options.

public : sealed class PrintHolePunchOptionDetails : IPrintItemListOptionDetails, IPrintOptionDetails
struct winrt::Windows::Graphics::Printing::OptionDetails::PrintHolePunchOptionDetails : IPrintItemListOptionDetails, IPrintOptionDetails
public sealed class PrintHolePunchOptionDetails : IPrintItemListOptionDetails, IPrintOptionDetails
Public NotInheritable Class PrintHolePunchOptionDetails Implements IPrintItemListOptionDetails, IPrintOptionDetails
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Here is a JavaScript code snippet that shows how to retrieve the object:

//  Retrieve the advanced Print Task Options
var printDetailedOptions = 
     Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails.getFromPrintTaskOptions(printTask.options);

// get the object
var printHolePunchOptionDetails = 
     printDetailedOptions.options.lookup(Windows.Graphics.Printing.StandardPrintTaskOptions.holePunch);

Version history

Windows version SDK version Value added
1803 17134 Description
1803 17134 WarningText

Properties

Description Description Description Description Description

Gets or sets the description of the hole punch option.

ErrorText ErrorText ErrorText ErrorText ErrorText

Gets or sets the string for an error condition.

Items Items Items Items Items

Gets the list of items for the hole punch option.

OptionId OptionId OptionId OptionId OptionId

Gets the ID for the hole punch option.

OptionType OptionType OptionType OptionType OptionType

Gets the option type for the hole punch option.

State State State State State

Gets or sets the state of the hole punch option.

Value Value Value Value Value

Gets or sets the enumerated value of the hole punch option.

WarningText WarningText WarningText WarningText WarningText

Gets or sets a string for a warning condition.

Methods

TrySetValue(Object) TrySetValue(Object) TrySetValue(Object) TrySetValue(Object) TrySetValue(Object)

Sets the value for the hole punch option.