Version: 2022.3
LanguageEnglish
  • C#

SearchSelection

class in UnityEditor.Search

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

Description

Provides methods to give readonly access to the current list of selected items in Search.

using UnityEngine;
using UnityEditor;
using UnityEditor.Search;

static class Example_ISearchView_AddSelection
{
    static ISearchView s_View;

    [MenuItem("Examples/ISearchView/AddSelection")]
    public static void Run()
    {
        s_View = SearchService.ShowContextual("asset");
        s_View.SetSearchText("t:MonoScript");

        EditorApplication.delayCall += DisplayResultsWhenReady;
    }

    public static void DisplayResultsWhenReady()
    {
        // Wait until results are ready to process.
        if (s_View.results.pending)
        {
            EditorApplication.delayCall += DisplayResultsWhenReady;
            return;
        }

        // Use AddSelection to append to the current selection.
        s_View.AddSelection(0);
        s_View.AddSelection(2);
        s_View.AddSelection(4);

        // Validate what is actually selected:
        var selection = s_View.selection;
        Debug.Log(selection.Count); // 3
        Debug.Log(selection.MinIndex()); // 0
        Debug.Log(selection.MaxIndex()); // 4
    }
}

Properties

CountThe number of items selected.

Constructors

SearchSelectionCreates a new SearchSelection.

Public Methods

ContainsChecks if the search item is contained in the current selection.
FirstGets the first selected item in the selection.
GetEnumeratorGets an enumerator on the currently selected SearchItems.
LastGets the last selected item in the selection.
MaxIndexHighest selected index of any item in the selection.
MinIndexLowest selected index of any item in the selection.