ISelection.set method

Applies to Windows and Windows Phone

Clears the current selection and replaces it with the specified items.

Syntax


iSelection.set(items).done( /* Your success and error handlers */ );

Parameters

items

Type: Object

The indexes or keys of the items that make up the selection. You can provide different types of objects for the items parameter: you can specify an index, a key, or a range of indexes. It can also be an array that contains one or more of these objects. For more info, see the Remarks section.

Return value

Type: Promise

A Promise that is fulfilled when the operation completes.

Remarks

The items parameter can be an index, a key, or a range of indexes, or an array that contains one or more of these objects.

  • An index: a numeric index value (Number)

    The set method adds the item at the specified index (the value of items) to the selection.

  • An index: an object that contains an index property that contains a Number

    The set method adds the item at the specified index (the value of items.index) to the selection.

  • A key: an object that contains a key property

    If the itemDataSource supports keys, the set method adds the item that has the specified key (the value of items.key) to the selection.

  • A range of indexes or keys: an object that implements ISelectionRange
    • If the object contains firstKey and lastKey values, the set method adds the items in the specified range to the selection, starting with the item at firstKey and ending with the item at lastKey.

    • If the object contains firstIndex and lastIndex values, the set method adds the items in the specified index range to the selection, starting with the item at firstIndex and ending with the item at lastIndex.

    • If the object contains both index and key values, the set method uses the key values.

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1

Namespace

WinJS.UI

See also

ISelection
ListView.selection

 

 

Show:
© 2014 Microsoft