Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


SearchProposition

Create a new search proposition.
Read time 2 minutesLast updated 12 days ago

Definition

SearchProposition(string, string, string, int, TextCursorPlacement, Texture2D, Color)

Create a new search proposition.
public SearchProposition(string label, string replacement = null, string help = null, int priority = 2147483647, TextCursorPlacement moveCursor = TextCursorPlacement.MoveAutoComplete, Texture2D icon = null, Color color = default)

Parameters

label

Display text of the proposition.

replacement

Text used to auto-complete the query when selected.

help

Help text used to display additional information about the search proposition.

priority

Value used to sort the propositions among other search propositions when displaying choices to the user.

Indicates when the text cursor should be moved when auto-completing the query with the selected proposition.

Icon used to display the proposition.

color

Color used in query builder mode to draw the block using a specific color.

Remarks

SearchProposition(string, string, string, int, Texture2D, Object, Color)

Create a new search proposition.
public SearchProposition(string label, string replacement, string help, int priority, Texture2D icon, object data, Color color = default)

Parameters

label

Display text of the proposition.

replacement

Text used to auto-complete the query when selected.

help

Help text used to display additional information about the search proposition.

priority

Value used to sort the propositions among other search propositions when displaying choices to the user.

Icon used to display the proposition.

data

User data that the user can retrieve later to determine the nature of the proposition.

color

Color used in query builder mode to draw the block using a specific color.

Remarks

SearchProposition(string, string, string, string, int, TextCursorPlacement, Texture2D, Type, Object, Color)

Create a new search proposition.
public SearchProposition(string category = null, string label = null, string replacement = null, string help = null, int priority = 0, TextCursorPlacement moveCursor = TextCursorPlacement.MoveAutoComplete, Texture2D icon = null, Type type = null, object data = null, Color color = default)

Parameters

category

Category text used to group propositions together in query builder mode.

label

Display text of the proposition.

replacement

Text used to auto-complete the query when selected.

help

Help text used to display additional information about the search proposition.

priority

Value used to sort the propositions among other search propositions when displaying choices to the user.

Indicates when the text cursor should be moved when auto-completing the query with the selected proposition.

Icon used to display the proposition.

type

Type of search proposition value. This information is used in the query builder mode.

data

User data that the user can retrieve later to determine the nature of the proposition.

color

Color used in query builder mode to draw the block using a specific color.

Remarks