PrintCustomItemListOptionDetails class

PrintCustomItemListOptionDetails class

Represents a list of the custom print task option items.

Syntax


/* For information about creating or accessing this object, see Remarks. */

Members

The PrintCustomItemListOptionDetails class has these types of members:

Methods

The PrintCustomItemListOptionDetails class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
AddItem Sets the ID or display name of an item in the list of custom print task options.
TrySetValue Sets the value for the item ID or the display name of the custom item.

 

Properties

The PrintCustomItemListOptionDetails class has these properties.

PropertyAccess typeDescription

DisplayName

Read/write

Gets or sets the display name of an item in the list of custom print task options.

ErrorText

Read/write

Gets or sets the string for an error condition.

Items

Read-only

Gets an item from the list of custom print tasks.

OptionId

Read-only

Gets the ID of a custom print task option.

OptionType

Read-only

Gets the option type for a custom print task option.

State

Read/write

Gets or sets the state of the list of custom print task option items.

Value

Read-only

Gets or sets the value of the list of custom print tasks.

 

Remarks

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


// Create a new list option
// This code creates a new item list option that will be shown to the user
// pageFormat is an object of type: PrintCustomItemListOptionDetails
var pageFormat = 
     printDetailedOptions.createItemListOption("PageContent", "Pictures");
pageFormat.addItem("PicturesText", "Pictures and text");
pageFormat.addItem("PicturesOnly", "Pictures only");
pageFormat.addItem("TextOnly", "Text only");

// later in your app, when you want to access that list again 
// and don’t have access to the pageFormat variable that was 
// returned when the list was created, you can get it by   
// looking up the same optionId that you used to create the list. 
var printCustomItemListOptionDetails = 
     printDetailedOptions.options.lookup("PageContent");


Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0 [for Xbox, see UWP features that aren't yet supported on Xbox]

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Graphics.Printing.OptionDetails
Windows::Graphics::Printing::OptionDetails [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

None supported

Namespace

Windows.Graphics.Printing.OptionDetails
Windows::Graphics::Printing::OptionDetails [C++]

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Agile)]
[Muse()]
[Version(0x06020000)]

See also

Object
IPrintOptionDetails
IPrintCustomOptionDetails
IPrintItemListOptionDetails

 

 

Show:
© 2016 Microsoft