PrintStapleOptionDetails Class

Reference

Definition

Namespace:: Windows.Graphics.Printing.OptionDetails

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a list of the stapling options.

public ref class PrintStapleOptionDetails sealed : IPrintItemListOptionDetails

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class PrintStapleOptionDetails final : IPrintItemListOptionDetails

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class PrintStapleOptionDetails : IPrintItemListOptionDetails

Public NotInheritable Class PrintStapleOptionDetails
Implements IPrintItemListOptionDetails

Inheritance: Object Platform::Object IInspectable PrintStapleOptionDetails

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Implements: IPrintItemListOptionDetails IPrintOptionDetails

Windows requirements

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

Remarks

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

//  Retrieve the advanced Print Task Options.
PrintTaskOptionDetails printDetailedOptions = PrintTaskOptionDetails.GetFromPrintTaskOptions(printTask.Options);

// Get the object.
PrintStapleOptionDetails printStapleOptionDetails =
     (PrintStapleOptionDetails)printDetailedOptions.Options[StandardPrintTaskOptions.Staple];

Version history

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

Properties

Description	Gets or sets the description of the print staple option.
ErrorText	Gets or sets the string for an error condition.
Items	Gets the list of items for the stapling options.
OptionId	Gets the ID for the stapling option.
OptionType	Gets the option type for the stapling option.
State	Gets or sets the state of the stapling option.
Value	Gets or sets the enumerated value of the stapling option.
WarningText	Gets or sets a string for a warning condition.

Methods

TrySetValue(Object)

Sets the value for the staple opiton.

Applies to

Jaa