PrintCollationOptionDetails 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 the list of print collation options.

public ref class PrintCollationOptionDetails sealed : IPrintItemListOptionDetails

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

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

Public NotInheritable Class PrintCollationOptionDetails
Implements IPrintItemListOptionDetails

Inheritance: Object Platform::Object IInspectable PrintCollationOptionDetails

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.
PrintCollationOptionDetails printCollationOptionDetails =
     (PrintCollationOptionDetails)printDetailedOptions.Options[StandardPrintTaskOptions.Collation];

Version history

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

Properties

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

Methods

TrySetValue(Object)

Sets the value for the print collation option.

Applies to

Share via