StorageFileQueryResult.FindStartIndexAsync | findStartIndexAsync method

Applies to Windows only

Retrieves the index of the file from the query results that most closely matches the specified property value (or file, if used with FileActivatedEventArgs.NeighboringFilesQuery). The property that is matched is determined by the first SortEntry of the QueryOptions.SortOrder list.

Syntax

Public Function FindStartIndexAsync(
  value As Object 
) As IAsyncOperation(Of UInteger)

Parameters

value

Type: Object [JavaScript] | System.Object [.NET] | Platform::Object [C++]

The property value to match when searching the query results. The property to that is used to match this value is the property in the first SortEntry of the QueryOptions.SortOrder list.

Or, the file to match when searching with FileActivatedEventArgs.NeighboringFilesQuery.

Return value

Type: IAsyncOperation<UInt32>

When this method completes successfully, it returns the index of the matched file in the query results or the index of the file in the FileActivatedEventArgs.NeighboringFilesQuery. In the latter case, the file is expected to be sourced from FileActivatedEventArgs.Files.

Remarks

You can use this method in conjunction with FileActivatedEventArgs.NeighboringFilesQuery to iterate between neighboring files while preserving the original view's sort order.

You can use this index in conjunction with Semantic Zoom to determine where the page should be zoomed in after the user selects the Semantic Zoom control. To learn about SemanticZoom in JavaScript, see Quickstart: adding SemanticZoom controls. To learn about SemanticZoom in C#/C++/VB, see Quickstart: adding SemanticZoom controls.

Examples

This example shows how to find the first song in an album that has a title beginning with the "R" in a set of query results that contains songs grouped by album title.

No code example is currently available or this language may not be supported.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

None supported

Namespace

Windows.Storage.Search
Windows::Storage::Search [C++]

Metadata

Windows.winmd

See also

StorageFileQueryResult

 

 

Show:
© 2014 Microsoft