PrintCustomItemListOptionDetails PrintCustomItemListOptionDetails PrintCustomItemListOptionDetails PrintCustomItemListOptionDetails PrintCustomItemListOptionDetails Class

Definition

Represents a list of the custom print task option items.

public : sealed class PrintCustomItemListOptionDetails : IPrintCustomOptionDetails, IPrintItemListOptionDetails, IPrintOptionDetails
struct winrt::Windows::Graphics::Printing::OptionDetails::PrintCustomItemListOptionDetails : IPrintCustomOptionDetails, IPrintItemListOptionDetails, IPrintOptionDetails
public sealed class PrintCustomItemListOptionDetails : IPrintCustomOptionDetails, IPrintItemListOptionDetails, IPrintOptionDetails
Public NotInheritable Class PrintCustomItemListOptionDetails Implements IPrintCustomOptionDetails, 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:

// 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");

Version history

Windows version SDK version Value added
1803 17134 AddItem(String,String,String,IRandomAccessStreamWithContentType)
1803 17134 Description
1803 17134 WarningText

Properties

Description Description Description Description Description

Gets or sets the description for the print custom item list option.

DisplayName DisplayName DisplayName DisplayName DisplayName

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

ErrorText ErrorText ErrorText ErrorText ErrorText

Gets or sets the string for an error condition.

Items Items Items Items Items

Gets an item from the list of custom print tasks.

OptionId OptionId OptionId OptionId OptionId

Gets the ID of a custom print task option.

OptionType OptionType OptionType OptionType OptionType

Gets the option type for a custom print task option.

State State State State State

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

Value Value Value Value Value

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

WarningText WarningText WarningText WarningText WarningText

Gets or sets a string for a warning condition.

Methods

AddItem(String, String) AddItem(String, String) AddItem(String, String) AddItem(String, String) AddItem(String, String)

Sets the ID or display name of an item in the list of custom print task options.

AddItem(String, String, String, IRandomAccessStreamWithContentType) AddItem(String, String, String, IRandomAccessStreamWithContentType) AddItem(String, String, String, IRandomAccessStreamWithContentType) AddItem(String, String, String, IRandomAccessStreamWithContentType) AddItem(String, String, String, IRandomAccessStreamWithContentType)

Sets the item ID, display name, description, or icon in the list of custom print item options.

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

Sets the value for the item ID or the display name of the custom item.