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: UnityEditor.Search

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

Type	Description
SearchContext

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

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

none

Declaration

[Obsolete("Use SearchItem.clear instead.", false)]
public static readonly SearchItem none

Field Value

Type	Description
SearchItem

options

Various flags that dictates how the search item is displayed and used.

Declaration

public SearchItemOptions options

Field Value

Type	Description
SearchItemOptions

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

Properties

clear

Declaration

public static SearchItem clear { get; }

Property Value

Type	Description
SearchItem

Item[String]

Declaration

public object this[string name] { get; }

Parameters

Type	Name	Description
String	name

Property Value

Type	Description
Object

value

Used to map value to a search item

Declaration

public object value { get; set; }

Property Value

Type	Description
Object

Methods

CompareTo(Object)

Generic item compare.

Declaration

public int CompareTo(object other)

Parameters

Type	Name	Description
Object	other

Returns

Type	Description
Int32

CompareTo(SearchItem)

Check if 2 SearchItems have the same id.

Declaration

public int CompareTo(SearchItem other)

Parameters

Type	Name	Description
SearchItem	other

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

Object.Equals(Object)

Equals(SearchItem)

Check if 2 SearchItems have the same id.

Declaration

public bool Equals(SearchItem other)

Parameters

Type	Name	Description
SearchItem	other

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

Type	Description
Int32

GetFieldNames()

Declaration

public string[] GetFieldNames()

Returns

Type	Description
String[]

GetFields()

Declaration

public IEnumerable<SearchField> GetFields()

Returns

Type	Description
IEnumerable<SearchField>

GetHashCode()

Default Hash of a SearchItem

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code for the current SearchItem

Overrides

Object.GetHashCode()

GetLabel(SearchContext, Boolean)

Fetch and format label.

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

Type	Name	Description
SearchContext	context
Vector2	size
FetchPreviewOptions	options
Boolean	cacheThumbnail

Returns

Type	Description
Texture2D

GetThumbnail(SearchContext, Boolean)

Fetch the item thumbnail.

Declaration

public Texture2D GetThumbnail(SearchContext context, bool cacheThumbnail = false)

Parameters

Type	Name	Description
SearchContext	context
Boolean	cacheThumbnail

Returns

Type	Description
Texture2D

GetValue(String, SearchContext)

Declaration

public object GetValue(string name = null, SearchContext context = null)

Parameters

Type	Name	Description
String	name
SearchContext	context

Returns

Type	Description
Object

RemoveField(String)

Declaration

public bool RemoveField(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

SetField(String, Object)

Declaration

public void SetField(string name, object value)

Parameters

Type	Name	Description
String	name
Object	value

SetField(String, String, Object)

Declaration

public void SetField(string name, string alias, object value)

Parameters

Type	Name	Description
String	name
String	alias
Object	value

ToGlobalId()

Declaration

[Obsolete("This API will be removed", true)]
public string ToGlobalId()

Returns

Type	Description
String

ToObject()

Declaration

public Object ToObject()

Returns

Type	Description
Object

ToObject(Type)

Declaration

public Object ToObject(Type type)

Parameters

Type	Name	Description
Type	type

Returns

Type	Description
Object

ToObject<T>()

Declaration

public T ToObject<T>()
    where T : Object

Returns

Type	Description
T

Type Parameters

Name	Description
T

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

TryGetField(String, out SearchField)

Declaration

public bool TryGetField(string name, out SearchField field)

Parameters

Type	Name	Description
String	name
SearchField	field

Returns

Type	Description
Boolean

TryGetValue(String, SearchContext, out SearchField)

Declaration

public bool TryGetValue(string name, SearchContext context, out SearchField field)

Parameters

Type	Name	Description
String	name
SearchContext	context
SearchField	field

Returns

Type	Description
Boolean

TryGetValue(String, out SearchField)

Declaration

public bool TryGetValue(string name, out SearchField field)

Parameters

Type	Name	Description
String	name
SearchField	field

Returns

Type	Description
Boolean