Class SearchContext | Quick Search | 1.5.4
docs.unity.cn
    Show / Hide Table of Contents

    Class SearchContext

    The search context contains many fields to process a search query.

    Inheritance
    Object
    SearchContext
    Namespace: Unity.QuickSearch
    Syntax
    public class SearchContext

    Fields

    Empty

    Default empty search context.

    Declaration
    public static readonly SearchContext Empty
    Field Value
    Type Description
    SearchContext

    Properties

    actionQueryId

    The search action id to be executed.

    Declaration
    public string actionQueryId { get; }
    Property Value
    Type Description
    String

    categories

    All sub categories related to this provider and their enabled state.

    Declaration
    public List<NameEntry> categories { get; }
    Property Value
    Type Description
    List<NameEntry>

    focusedWindow

    Editor window that initiated the search.

    Declaration
    public EditorWindow focusedWindow { get; }
    Property Value
    Type Description
    EditorWindow

    isActionQuery

    Indicates if the current search tries to execute a specific action on the search results.

    Declaration
    public bool isActionQuery { get; }
    Property Value
    Type Description
    Boolean

    searchQuery

    Processed search query (no filterId, no textFilters)

    Declaration
    public string searchQuery { get; }
    Property Value
    Type Description
    String

    searchText

    Raw search text (i.e. what is in the search text box)

    Declaration
    public string searchText { get; }
    Property Value
    Type Description
    String

    searchWords

    Search query tokenized by words. All text filters are discarded and all words are lower cased.

    Declaration
    public string[] searchWords { get; }
    Property Value
    Type Description
    String[]

    textFilters

    All tokens containing a colon (':')

    Declaration
    public string[] textFilters { get; }
    Property Value
    Type Description
    String[]

    totalItemCount

    Mark the number of item found after running the search.

    Declaration
    public int totalItemCount { get; }
    Property Value
    Type Description
    Int32

    wantsMore

    Indicates if the search should return results as many as possible.

    Declaration
    public bool wantsMore { get; }
    Property Value
    Type Description
    Boolean
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX