Class SearchItem | Quick Search | 1.5.4
docs.unity3d.com
    Show / Hide Table of Contents

    Class SearchItem

    Search items are returned by the search provider when some results need to be shown to the user after a search is made. The search item holds all the data that will be used to sort and present the search results.

    Inheritance
    Object
    SearchItem
    Namespace: Unity.QuickSearch
    Syntax
    public class SearchItem : IEqualityComparer<SearchItem>, IEquatable<SearchItem>

    Constructors

    SearchItem(String)

    Construct a search item. Minimally a search item need to have a unique id for a given search query.

    Declaration
    public SearchItem(string _id)
    Parameters
    Type Name Description
    String _id

    Fields

    data

    Search provider defined content. It can be used to transport any data to custom search provider handlers (i.e. fetchDescription).

    Declaration
    public object data
    Field Value
    Type Description
    Object

    description

    If no description is provided, SearchProvider.fetchDescription will be called when the item is first displayed.

    Declaration
    public string description
    Field Value
    Type Description
    String

    descriptionFormat

    If true - description already has formatting / rich text

    Declaration
    public SearchItemDescriptionFormat descriptionFormat
    Field Value
    Type Description
    SearchItemDescriptionFormat

    id

    Unique id of this item among this provider items.

    Declaration
    public readonly string id
    Field Value
    Type Description
    String

    label

    Display name of the item

    Declaration
    public string label
    Field Value
    Type Description
    String

    preview

    Large preview of the search item. Usually cached by fetchPreview.

    Declaration
    public Texture2D preview
    Field Value
    Type Description
    Texture2D

    provider

    Back pointer to the provider.

    Declaration
    public SearchProvider provider
    Field Value
    Type Description
    SearchProvider

    score

    The item score can affect how the item gets sorted within the same provider.

    Declaration
    public int score
    Field Value
    Type Description
    Int32

    thumbnail

    If no thumbnail are provider, SearchProvider.fetchThumbnail will be called when the item is first displayed.

    Declaration
    public Texture2D thumbnail
    Field Value
    Type Description
    Texture2D

    Methods

    Equals(SearchItem)

    Declaration
    public bool Equals(SearchItem other)
    Parameters
    Type Name Description
    SearchItem other
    Returns
    Type Description
    Boolean

    Equals(SearchItem, SearchItem)

    Declaration
    public bool Equals(SearchItem x, SearchItem y)
    Parameters
    Type Name Description
    SearchItem x
    SearchItem y
    Returns
    Type Description
    Boolean

    GetHashCode(SearchItem)

    Declaration
    public int GetHashCode(SearchItem obj)
    Parameters
    Type Name Description
    SearchItem obj
    Returns
    Type Description
    Int32
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023