Version: 2021.1
LanguageEnglish
  • C#

SearchService.CreateContext

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static Search.SearchContext CreateContext(string searchText);

Declaration

public static Search.SearchContext CreateContext(string searchText, Search.SearchFlags flags);

Declaration

public static Search.SearchContext CreateContext(Search.SearchProvider provider, string searchText);

Declaration

public static Search.SearchContext CreateContext(string providerId, string searchText, Search.SearchFlags flags);

Declaration

public static Search.SearchContext CreateContext(IEnumerable<string> providerIds, string searchText, Search.SearchFlags flags);

Declaration

public static Search.SearchContext CreateContext(IEnumerable<SearchProvider> providers, string searchText, Search.SearchFlags flags);

Parameters

searchText Search Query.
provider Search provider (This search provider does not need to be active or registered).
providerId Unique search provider ID string (i.e. asset, scene, find, etc.)
providerIds List of search provider IDs.
providers List of search providers.
flags Options defining how the query is performed.

Returns

SearchContext Returns a new SearchContext.

Description

Creates context from a list of search provider IDs.

using UnityEditor;
using UnityEditor.Search;
using UnityEngine;

static class Example_SearchService_CreateContext
{
    [MenuItem("Examples/SearchService/CreateContext")]
    public static void Run()
    {
        using var searchContext = SearchService.CreateContext("scene", "camera");
        using var results = SearchService.Request(searchContext);
        {
            foreach (var label in results.Select(r => r.GetLabel(searchContext)))
                Debug.Log(label);
        }
    }
}