SearchPane class

Represents and manages the search pane that opens when a user activates the Search charm. The search pane provides a consistent, touch-friendly search box and optional search suggestions.

Syntax

var searchPane = Windows.ApplicationModel.Search.SearchPane.getForCurrentView();

Attributes

MarshalingBehaviorAttribute(Standard)

MuseAttribute()

StaticAttribute(Windows.ApplicationModel.Search.ISearchPaneStatics, NTDDI_WIN8)

VersionAttribute(NTDDI_WIN8)

Members

The SearchPane class has these types of members:

• Events
• Methods
• Properties

Events

The SearchPane class has these events.

Methods

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

Properties

The SearchPane class has these properties.

Remarks

This object is available to apps that participate in the Search contract; you can learn more about adding the Search contract to your app in Quickstart: Adding search. In order to provide users with search results, you must add code to your activated event handler that responds when your app is activated for search. To learn more about responding to search activation events see webUISearchActivatedEventArgs (JavaScript) or SearchActivatedEventArgs (C#/C++/VB).

You can see code examples that demonstrate how to respond to search events and manage the search pane in the Search contract sample.

Examples

For C#/C++/VB: This example demonstrates how to ensure that your app can respond to user queries at any time by overriding OnWindowCreated in App.xaml.cs/App.xaml.cpp/App.xaml.vb to access the SearchPane object and register handlers for SearchPane events (like QuerySubmitted).

protected override void OnWindowCreated(WindowCreatedEventArgs args)
{
    // At window creation time, access the SearchPane object and register SearchPane events
    // (like QuerySubmitted, SuggestionsRequested, and ResultSuggestionChosen) so that the app
    // can respond to the user's search queries at any time.

    // Get search pane
    Windows.ApplicationModel.Search.SearchPane searchPane = SearchSearchPane.GetForCurrentView();
    
    // Register event handlers for SearchPane events

    // Register QuerySubmitted event handler
    searchPane.QuerySubmitted += new TypedEventHandler<SearchPane, SearchPaneQuerySubmittedEventArgs>(OnQuerySubmitted);
    
    // Register a SuggestionsRequested if your app displays its own suggestions in the search pane (like from a web service)
    // Register a ResultSuggestionChosen if your app uses result suggestions in the search pane    
}

For JavaScript: This example demonstrates how to access the searchPane to register a querysubmitted event handler.

Note  To ensure that your app can respond to user queries at any time, make sure your searchPane event handlers are registered in your app's global scope.

// Register event handler for QuerySubmitted
Windows.ApplicationModel.Search.SearchPane.getForCurrentView().onquerysubmitted = function (eventObject) {
    // Respond to query and perform search
};

Requirements

See also

Search contract sample

Quickstart: Adding search

How to handle app activation (JS)

How to activate an app (C#/C++/VB)

Reference

SearchPane.GetForCurrentView method

Windows.ApplicationModel.Activation.ActivationKind enum

Windows.ApplicationModel.Activation.SearchActivatedEventArgs class

Windows.ApplicationModel.Core.CoreApplicationView.Activated event

Build date: 12/4/2012