Print​Collation​Option​Details Print​Collation​Option​Details Print​Collation​Option​Details Class

Definition

Represents the list of print collation options.

public sealed class PrintCollationOptionDetails : IPrintItemListOptionDetails, IPrintOptionDetailspublic sealed class PrintCollationOptionDetails : IPrintItemListOptionDetails, IPrintOptionDetailsPublic NotInheritable Class PrintCollationOptionDetails Implements IPrintItemListOptionDetails, IPrintOptionDetails
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 printCollationOptionDetails = 
     printDetailedOptions.options.lookup(Windows.Graphics.Printing.StandardPrintTaskOptions.collation);

Properties

ErrorText ErrorText ErrorText

Gets or sets the string for an error condition.

public string ErrorText { get; set; }public string ErrorText { get; set; }Public ReadWrite Property ErrorText As string
Value
string string string

String that describes the error condition.

Attributes

Items Items Items

Gets the list of items for the print collation option.

public IVectorView<object> Items { get; }public IVectorView<object> Items { get; }Public ReadOnly Property Items As IVectorView<object>
Value

Pointer to the list of items.

Attributes

OptionId OptionId OptionId

Gets the ID of the print collation option.

public string OptionId { get; }public string OptionId { get; }Public ReadOnly Property OptionId As string
Value
string string string

The ID of the collation option.

Attributes

OptionType OptionType OptionType

Gets the option type for the print collation option.

public PrintOptionType OptionType { get; }public PrintOptionType OptionType { get; }Public ReadOnly Property OptionType As PrintOptionType
Attributes

State State State

Gets or sets the state of the print collation option.

public PrintOptionStates State { get; set; }public PrintOptionStates State { get; set; }Public ReadWrite Property State As PrintOptionStates
Value
PrintOptionStates PrintOptionStates PrintOptionStates

The state of the collation option.

Attributes

Value Value Value

Gets or sets the enumerated value of the print collation option.

public object Value { get; }public object Value { get; }Public ReadOnly Property Value As object
Value
object object object

The value of the print collation option.

Attributes

Methods

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

Sets the value for the print collation option.

public bool TrySetValue(Object value)public bool TrySetValue(Object value)Public Function TrySetValue(value As Object) As bool
Parameters
value
System.Object System.Object System.Object

Value for the print collation option.

Returns
bool bool bool

Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Attributes