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 : IEquatable<SearchItem>, IComparable<SearchItem>, IComparable
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
context
Context used to create that item.
Declaration
public SearchContext context
Field Value
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
id
Unique id of this item among this provider items.
Declaration
public readonly string id
Field Value
label
Declaration
Field Value
none
Declaration
[Obsolete("Use SearchItem.clear instead.", false)]
public static readonly SearchItem none
Field Value
options
Various flags that dictates how the search item is displayed and used.
Declaration
public SearchItemOptions options
Field Value
preview
Large preview of the search item. Usually cached by fetchPreview.
Declaration
Field Value
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
Properties
clear
Declaration
public static SearchItem clear { get; }
Property Value
Item[String]
Declaration
public object this[string name] { get; }
Parameters
| Type |
Name |
Description |
| String |
name |
|
Property Value
value
Used to map value to a search item
Declaration
public object value { get; set; }
Property Value
Methods
CompareTo(Object)
Declaration
public int CompareTo(object other)
Parameters
| Type |
Name |
Description |
| Object |
other |
|
Returns
CompareTo(SearchItem)
Check if 2 SearchItems have the same id.
Declaration
public int CompareTo(SearchItem other)
Parameters
Returns
| Type |
Description |
| Int32 |
Returns true if SearchItem have the same id.
|
Equals(Object)
Check if 2 SearchItems have the same id.
Declaration
public override bool Equals(object other)
Parameters
| Type |
Name |
Description |
| Object |
other |
|
Returns
| Type |
Description |
| Boolean |
Returns true if SearchItem have the same id.
|
Overrides
Equals(SearchItem)
Check if 2 SearchItems have the same id.
Declaration
public bool Equals(SearchItem other)
Parameters
Returns
| Type |
Description |
| Boolean |
Returns true if SearchItem have the same id.
|
GetDescription(SearchContext, Boolean)
Fetch and format description
Declaration
public string GetDescription(SearchContext context, bool stripHTML = false)
Parameters
| Type |
Name |
Description |
| SearchContext |
context |
Any search context for the item provider.
|
| Boolean |
stripHTML |
True if any HTML tags should be dropped.
|
Returns
| Type |
Description |
| String |
The search item description
|
GetFieldCount()
Declaration
public int GetFieldCount()
Returns
GetFieldNames()
Declaration
public string[] GetFieldNames()
Returns
GetFields()
Declaration
public IEnumerable<SearchField> GetFields()
Returns
GetHashCode()
Default Hash of a SearchItem
Declaration
public override int GetHashCode()
Returns
| Type |
Description |
| Int32 |
A hash code for the current SearchItem
|
Overrides
GetLabel(SearchContext, Boolean)
Declaration
public string GetLabel(SearchContext context, bool stripHTML = false)
Parameters
| Type |
Name |
Description |
| SearchContext |
context |
Any search context for the item provider.
|
| Boolean |
stripHTML |
True if any HTML tags should be dropped.
|
Returns
| Type |
Description |
| String |
The search item label
|
GetPreview(SearchContext, Vector2, FetchPreviewOptions, Boolean)
Fetch the item preview if any.
Declaration
public Texture2D GetPreview(SearchContext context, Vector2 size, FetchPreviewOptions options = FetchPreviewOptions.Normal, bool cacheThumbnail = false)
Parameters
Returns
GetThumbnail(SearchContext, Boolean)
Fetch the item thumbnail.
Declaration
public Texture2D GetThumbnail(SearchContext context, bool cacheThumbnail = false)
Parameters
Returns
GetValue(String, SearchContext)
Declaration
public object GetValue(string name = null, SearchContext context = null)
Parameters
Returns
RemoveField(String)
Declaration
public bool RemoveField(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
Returns
SetField(String, Object)
Declaration
public void SetField(string name, object value)
Parameters
SetField(String, String, Object)
Declaration
public void SetField(string name, string alias, object value)
Parameters
ToGlobalId()
Declaration
[Obsolete("This API will be removed", true)]
public string ToGlobalId()
Returns
ToObject()
Declaration
Returns
ToObject(Type)
Declaration
public Object ToObject(Type type)
Parameters
| Type |
Name |
Description |
| Type |
type |
|
Returns
ToObject<T>()
Declaration
public T ToObject<T>()
where T : Object
Returns
Type Parameters
ToString()
Declaration
public override string ToString()
Returns
Overrides
TryGetField(String, out SearchField)
Declaration
public bool TryGetField(string name, out SearchField field)
Parameters
Returns
TryGetValue(String, SearchContext, out SearchField)
Declaration
public bool TryGetValue(string name, SearchContext context, out SearchField field)
Parameters
Returns
TryGetValue(String, out SearchField)
Declaration
public bool TryGetValue(string name, out SearchField field)
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.