Difference between revisions of "GUISearchField"
From Virtual World Web Wiki
(Documentation for the GUISearchField class) |
(Documentation for the GUISearchField class) |
||
| Line 2: | Line 2: | ||
* This is a JavaScript visible object | * This is a JavaScript visible object | ||
===Remarks <nowiki>[</nowiki>[{{fullurl:GUISearchField Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:GUISearchField Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
| − | {{:GUISearchField Remarks}} | + | {{#ifexist:GUISearchField Remarks|{{:GUISearchField Remarks}}|}} |
===Properties=== | ===Properties=== | ||
:{{CSharp|GUIButton ClearButton {get;} }} | :{{CSharp|GUIButton ClearButton {get;} }} | ||
| + | :: | ||
| + | ::Button displayed to the right of the search field for clearing the text | ||
:{{CSharp|bool DisplayPreviousResults {get; set;} }} | :{{CSharp|bool DisplayPreviousResults {get; set;} }} | ||
| + | :: | ||
| + | ::Enables prevous search menu | ||
:{{CSharp|int MaxStoredResults {get; set;} }} | :{{CSharp|int MaxStoredResults {get; set;} }} | ||
| + | :: | ||
| + | ::The maximum amount of previous searches to store | ||
| + | ::Note: Only manually commited searches are added | ||
:{{CSharp|int MinimumSearchLength {get; set;} }} | :{{CSharp|int MinimumSearchLength {get; set;} }} | ||
| + | :: | ||
| + | ::Minimum number of characters before we trigger a search | ||
:{{CSharp|string Placeholder {get; set;} }} | :{{CSharp|string Placeholder {get; set;} }} | ||
| + | :: | ||
| + | ::A value that will be displayed when there is no search value | ||
| + | ::And the search control is not in focus | ||
:{{CSharp|GUILabel PlaceholderLabel {get;} }} | :{{CSharp|GUILabel PlaceholderLabel {get;} }} | ||
| + | :: | ||
| + | ::The placeholder label displayed when there is no search and the text field is not focused | ||
:{{CSharp|int RecentSearchCount {get;} }} | :{{CSharp|int RecentSearchCount {get;} }} | ||
| + | :: | ||
| + | ::Returns how many entries there are in the recent searches list. | ||
:{{CSharp|float ResultsDelay {get; set;} }} | :{{CSharp|float ResultsDelay {get; set;} }} | ||
| + | :: | ||
| + | ::A delay between typing and when the search starts (In seconds) | ||
:{{CSharp|GUIImageBox SearchIcon {get;} }} | :{{CSharp|GUIImageBox SearchIcon {get;} }} | ||
| + | :: | ||
| + | ::Icon displayed to the left of the search field | ||
:{{CSharp|bool ShowClearButton {get; set;} }} | :{{CSharp|bool ShowClearButton {get; set;} }} | ||
| + | :: | ||
| + | ::Allows the clear button to display if there is a search value | ||
:{{CSharp|bool SubmitOnEnter {get; set;} }} | :{{CSharp|bool SubmitOnEnter {get; set;} }} | ||
| + | :: | ||
| + | ::Should submit automatically fire when the user presses Enter? | ||
:{{CSharp|string Value {get; set;} }} | :{{CSharp|string Value {get; set;} }} | ||
| + | :: | ||
| + | ::The value that will be searched upon commit | ||
===Events=== | ===Events=== | ||
:{{CSharp|OnSearchChanged()}} | :{{CSharp|OnSearchChanged()}} | ||
| + | :: | ||
| + | ::Event fired when a search is submitted | ||
:{{CSharp|OnTextChanged()}} | :{{CSharp|OnTextChanged()}} | ||
| + | :: | ||
| + | ::Event fired whenever the text in the search field changes | ||
===Methods=== | ===Methods=== | ||
| − | :{{CSharp| | + | :{{CSharp|void AddRecent(string recent)}} |
| + | :: | ||
| + | ::Adds an item to the recent searches list | ||
| − | :{{CSharp| | + | :{{CSharp|void ClearRecents()}} |
| + | :: | ||
| + | ::Clears all entries from the recent searches list | ||
| − | :{{CSharp| | + | :{{CSharp|int FindRecent(string recent)}} |
| + | :: | ||
| + | ::Returns the index of the recent search entry matching | ||
| − | :{{CSharp| | + | :{{CSharp|string GetRecent(int index)}} |
| + | :: | ||
| + | ::Returns the recent search at a particular index | ||
| + | |||
| + | :{{CSharp|void RemoveRecent(string recent)}} | ||
| + | :: | ||
| + | ::Removes an entry for the recent searches list | ||
:{{CSharp|void SetFocus()}} | :{{CSharp|void SetFocus()}} | ||
Revision as of 21:07, 12 April 2017
- Inherits class: GUISelectableComponent
- This is a JavaScript visible object
Remarks [edit]
Properties
- GUIButton ClearButton {get;}
- Button displayed to the right of the search field for clearing the text
- bool DisplayPreviousResults {get; set;}
- Enables prevous search menu
- int MaxStoredResults {get; set;}
- The maximum amount of previous searches to store
- Note: Only manually commited searches are added
- int MinimumSearchLength {get; set;}
- Minimum number of characters before we trigger a search
- string Placeholder {get; set;}
- A value that will be displayed when there is no search value
- And the search control is not in focus
- GUILabel PlaceholderLabel {get;}
- The placeholder label displayed when there is no search and the text field is not focused
- int RecentSearchCount {get;}
- Returns how many entries there are in the recent searches list.
- float ResultsDelay {get; set;}
- A delay between typing and when the search starts (In seconds)
- GUIImageBox SearchIcon {get;}
- Icon displayed to the left of the search field
- bool ShowClearButton {get; set;}
- Allows the clear button to display if there is a search value
- bool SubmitOnEnter {get; set;}
- Should submit automatically fire when the user presses Enter?
- string Value {get; set;}
- The value that will be searched upon commit
Events
- OnSearchChanged()
- Event fired when a search is submitted
- OnTextChanged()
- Event fired whenever the text in the search field changes
Methods
- void AddRecent(string recent)
- Adds an item to the recent searches list
- void ClearRecents()
- Clears all entries from the recent searches list
- int FindRecent(string recent)
- Returns the index of the recent search entry matching
- string GetRecent(int index)
- Returns the recent search at a particular index
- void RemoveRecent(string recent)
- Removes an entry for the recent searches list
- void SetFocus()
- Brings focus to this component
