Windows Dev Center

SearchPaneSuggestionsRequestDeferral class

Enables the app to signal when it has finished populating a searchSuggestionCollection object while handling the suggestionsrequested event. Apps should use a deferral if and only if they need to respond to a request for suggestions asynchronously.

Syntax


Public NotInheritable Class SearchPaneSuggestionsRequestDeferral

Attributes

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

Members

The SearchPaneSuggestionsRequestDeferral class has these types of members:

Methods

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

MethodDescription
Complete Signals that the app has finished populating a searchSuggestionCollection object while handling the suggestionsrequested event.

 

Remarks

Your app should respond asynchronously to a request for suggestions if fulfilling the request will take a significant amount of time, such as fetching suggestions from a web service.

Use the searchPaneSuggestionsRequestDeferral.complete method to signal when your app has fulfilled the request.

An app retrieves this object by calling the searchPaneSuggestionsRequest.getDeferral method while handling the suggestionsrequested event.

Examples

The Search contract sample demonstrates how to respond to a suggestionsrequested event, including how to get a deferral.

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

Requirements (device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

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.ApplicationModel.Search
Windows::ApplicationModel::Search [C++]

Metadata

Windows.winmd

See also

Object
Reference
SearchPane class
SearchPane.SuggestionsRequested event
SearchPaneSuggestionsRequest class
SearchPaneSuggestionsRequest.GetDeferral method
SearchPaneSuggestionsRequestedEventArgs class

 

 

Show:
© 2015 Microsoft