SearchViewState

class in UnityEditor.Search

Leave feedback

Implements interfaces:ISerializationCallbackReceiver

Suggest a change

Description

Search view state is used to create new Search windows. See SearchService.ShowWindow.

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);
    }
}

Static Properties

Property	Description
defaultSize	Determine the default search view size when it first opens.

Properties

Property	Description
context	Search context used to populate the search view.
excludeClearItem	Set to true to hide the None item when in picker mode.
flags	Various search view options.
group	Indicates the group or tab to be selected when the Search window opens.
groupChanged	External handler used to be notified when the user changes the current group/tab.
hasQueryPanel	Is the SearchViewState allows for the left side Query panel to be shown.
hasWindowSize	Determines if the search view was opened with a predefined size. If false, then it means the search view was opened the previous window size it was last closed with.
hideAllGroup	Determine if the All group/tab should be hidden.
hideTabs	Indicates if the search tabs (group providers) should be hidden or shown.
ignoreSaveSearches	If true, the search view will not load previous saved searches.
isQueryPanelVisible	Is the Left side query panel shown?
itemSize	Indicates the item size to be used when the Search window opens.
position	If defined, indicates the ___location of the new Search window when it opens.
queryBuilderEnabled	If true, the search view will be opened in builder mode.
selectHandler	External handler triggered when the user has selected an item in picker mode.
sessionId	Unique session ID generated by the system each time a search view is opened.
tableConfig	Access the search table configuration used if in table view.
text	Text used to initialize the search view.
title	Indicates the search topic title.
trackingHandler	External handler triggered each time the user clicks on an item in the search view.
windowSize	Determine the size the search view was opened with.
windowTitle	If defined, this title will be used to open a new search view and sets the EditorWindow.titleContent.

Constructors

Constructor	Description
SearchViewState	Create search view flags used to create a new Search window.

Public Methods

Method	Description
GetProviderIds	Returns all the search provider ids in the current search context.
GetProviderTypes	Returns all the search provider types in the current search context.
HasFlag	Checks if the search view was defined with specific set of flags.
ToString	Convert SearchViewState to a string.

Static Methods

Method	Description
CreatePickerState	Create a SearchViewState specially setup to show an Object Picker.
LoadDefaults	Returns a newly created default search view state.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Scripting API