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.
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
Field Value
description
If no description is provided, SearchProvider.fetchDescription will be called when the item is first displayed.
Declaration
public string description
Field Value
If true - description already has formatting / rich text
Declaration
public SearchItemDescriptionFormat descriptionFormat
Field Value
id
Unique id of this item among this provider items.
Declaration
public readonly string id
Field Value
label
Declaration
Field Value
preview
Large preview of the search item. Usually cached by fetchPreview.
Declaration
Field Value
| Type |
Description |
| Texture2D |
|
provider
Back pointer to the provider.
Declaration
public SearchProvider provider
Field Value
score
The item score can affect how the item gets sorted within the same provider.
Declaration
Field Value
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
Returns
Equals(SearchItem, SearchItem)
Declaration
public bool Equals(SearchItem x, SearchItem y)
Parameters
Returns
GetHashCode(SearchItem)
Declaration
public int GetHashCode(SearchItem obj)
Parameters
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.