Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

ShowWindow

Creates a new search window.
Read time 2 minutesLast updated 12 days ago

Definition

ShowWindow(SearchContext, string, float, float, bool, bool, bool, bool)

Creates a new search window.
public static ISearchView ShowWindow(SearchContext context = null, string topic = "Unity", float defaultWidth = 850, float defaultHeight = 539, bool saveFilters = true, bool reuseExisting = false, bool multiselect = true, bool dockable = true)

Parameters

context

SearchContext
Search context to start with.

topic

string
Topic to search.

defaultWidth

float
Initial width of the window.

defaultHeight

float
Initial height of the window.

saveFilters

bool
True if user search provider filters should be saved for next search session.

reuseExisting

bool
True if the active providers should be saved for the next session.

multiselect

bool
True if the search supports multi-selection.

dockable

bool
If true, creates a dockable search window (that is closed when an item is activated). If false, it creates a dropdown (borderless, undockable and unmovable) version of the search window.

Returns

Type

Description

ISearchViewReturns the search view window instance.

Examples

using UnityEditor;using UnityEditor.Search;static class Example_SearchService_ShowWindow{    [MenuItem("Examples/SearchService/ShowWindowEmpty")]    public static void Run1()    {        SearchService.ShowWindow()            .SetSearchText(string.Empty);    }    [MenuItem("Examples/SearchService/ShowWindowWithSearchText")]    public static void Run2()    {        SearchService.ShowWindow(SearchService.CreateContext("m: Profiler"));    }    [MenuItem("Examples/SearchService/ShowWindowCustomTopic")]    public static void Run3()    {        SearchService.ShowWindow(topic: "My Things")            .SetSearchText(string.Empty);    }    [MenuItem("Examples/SearchService/ShowPopupWindow")]    public static void Run4()    {        SearchService.ShowWindow(defaultWidth: 1300, defaultHeight: 700, dockable: false);    }}

ShowWindow(SearchViewState)

Creates a new search window.
public static ISearchView ShowWindow(SearchViewState viewState)

Parameters

viewState

SearchViewState
Search view state used to open the Search window.

Returns

Type

Description

ISearchViewReturns the search view window instance.

Examples

using UnityEditor;using UnityEditor.Search;using UnityEngine.Search;static class SearchWindows{    [MenuItem("Search/Views/Simple Search Bar 1")] public static void SearchViewFlags1() => CreateWindow(SearchViewFlags.None);    [MenuItem("Search/Views/Simple Search Bar 2")] public static void SearchViewFlags2() => CreateWindow(SearchViewFlags.EnableSearchQuery);    [MenuItem("Search/Views/Simple Search Bar 3")] public static void SearchViewFlags3() => CreateWindow(SearchViewFlags.DisableInspectorPreview);    [MenuItem("Search/Views/Simple Search Bar 4")] public static void SearchViewFlags4() => CreateWindow(SearchViewFlags.EnableSearchQuery | SearchViewFlags.DisableInspectorPreview);    static void CreateWindow(SearchViewFlags flags)    {        var searchContext = SearchService.CreateContext(string.Empty);        var viewArgs = new SearchViewState(searchContext, SearchViewFlags.CompactView | flags) { title = flags.ToString() };        SearchService.ShowWindow(viewArgs);    }}