PrintMediaSizeOptionDetails PrintMediaSizeOptionDetails PrintMediaSizeOptionDetails PrintMediaSizeOptionDetails Class

Definition

Represents the list of media size options.

public : sealed class PrintMediaSizeOptionDetails : IPrintItemListOptionDetails, IPrintOptionDetails
public sealed class PrintMediaSizeOptionDetails : IPrintItemListOptionDetails, IPrintOptionDetails
Public NotInheritable Class PrintMediaSizeOptionDetails 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 printMediaSizeOptionDetails = 
     printDetailedOptions.options.lookup(Windows.Graphics.Printing.StandardPrintTaskOptions.mediaSize);

Properties

ErrorText ErrorText ErrorText ErrorText

Gets or sets the string for an error condition.

public : Platform::String ErrorText { get; set; }
public string ErrorText { get; set; }
Public ReadWrite Property ErrorText As string
var string = printMediaSizeOptionDetails.errorText;
printMediaSizeOptionDetails.errorText = string;
Value
Platform::String string string string

String that describes the error condition.

Items Items Items Items

Gets the list of print media size option items.

public : IVectorView<Platform::Object> Items { get; }
public IReadOnlyList<object> Items { get; }
Public ReadOnly Property Items As IReadOnlyList<object>
var iReadOnlyList = printMediaSizeOptionDetails.items;
Value
IVectorView<Platform::Object> IReadOnlyList<object> IReadOnlyList<object> IReadOnlyList<object>

A pointer to the list of items.

OptionId OptionId OptionId OptionId

Gets the ID for the print media size option.

public : Platform::String OptionId { get; }
public string OptionId { get; }
Public ReadOnly Property OptionId As string
var string = printMediaSizeOptionDetails.optionId;
Value
Platform::String string string string

The ID for the media size option.

OptionType OptionType OptionType OptionType

Gets the option type for the option for the number of printed copies.

public : PrintOptionType OptionType { get; }
public PrintOptionType OptionType { get; }
Public ReadOnly Property OptionType As PrintOptionType
var printOptionType = printMediaSizeOptionDetails.optionType;

State State State State

Gets or sets the state of the option for the number of printed copies.

public : PrintOptionStates State { get; set; }
public PrintOptionStates State { get; set; }
Public ReadWrite Property State As PrintOptionStates
var printOptionStates = printMediaSizeOptionDetails.state;
printMediaSizeOptionDetails.state = printOptionStates;

Value Value Value Value

Gets or sets the number of copies for a print task.

public : Platform::Object Value { get; }
public object Value { get; }
Public ReadOnly Property Value As object
var object = printMediaSizeOptionDetails.value;
Value
Platform::Object object object object

The number of copies for a print task.

Methods

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

Sets the value for the media size option.

public : Platform::Boolean TrySetValue(Platform::Object value)
public bool TrySetValue(Object value)
Public Function TrySetValue(value As Object) As bool
var bool = printMediaSizeOptionDetails.trySetValue(value);
Parameters
value
Platform::Object Object Object Object

Value for the media size option.

Returns
Platform::Boolean bool bool bool

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