IListBinding.fromKey method

Retrieves the item from the IListDataSource that has the specified key and makes it the current item.

Syntax

iListBinding.fromKey(key, hints).done( /* Your success and error handlers */ );

Parameters

  • key
    Type: String

    The key that identifies the item to retrieve. This value must be a non-empty string.

  • hints [optional]
    Type: Object

    Domain-specific information that provides additional information to the IListDataAdapter to improve retrieval time.

Return value

Type: IItemPromise**

An IItemPromise that contains the requested IItem. If they item couldn't be found, the promise completes with a value of null.

Requirements

Minimum WinJS version

WinJS 3.0

Namespace

WinJS.UI

See also

IListBinding