Difference between revisions of "GUISearchField"
From Virtual World Web Wiki
(Documentation for the GUISearchField class) |
(Documentation for the GUISearchField class) |
||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
*'''Inherits class: [[GUISelectableComponent]]''' | *'''Inherits class: [[GUISelectableComponent]]''' | ||
* This is a JavaScript visible object | * This is a JavaScript visible object | ||
| Line 8: | Line 6: | ||
===Properties=== | ===Properties=== | ||
:{{CSharp|GUIButton ClearButton {get;} }} | :{{CSharp|GUIButton ClearButton {get;} }} | ||
| − | |||
| − | |||
:{{CSharp|bool DisplayPreviousResults {get; set;} }} | :{{CSharp|bool DisplayPreviousResults {get; set;} }} | ||
| − | |||
| − | |||
:{{CSharp|int MaxStoredResults {get; set;} }} | :{{CSharp|int MaxStoredResults {get; set;} }} | ||
| − | |||
| − | |||
| − | |||
:{{CSharp|int MinimumSearchLength {get; set;} }} | :{{CSharp|int MinimumSearchLength {get; set;} }} | ||
| − | |||
| − | |||
:{{CSharp|string Placeholder {get; set;} }} | :{{CSharp|string Placeholder {get; set;} }} | ||
| − | |||
| − | |||
| − | |||
:{{CSharp|GUILabel PlaceholderLabel {get;} }} | :{{CSharp|GUILabel PlaceholderLabel {get;} }} | ||
| − | |||
| − | |||
:{{CSharp|int RecentSearchCount {get;} }} | :{{CSharp|int RecentSearchCount {get;} }} | ||
| − | |||
| − | |||
:{{CSharp|float ResultsDelay {get; set;} }} | :{{CSharp|float ResultsDelay {get; set;} }} | ||
| − | |||
| − | |||
:{{CSharp|GUIImageBox SearchIcon {get;} }} | :{{CSharp|GUIImageBox SearchIcon {get;} }} | ||
| − | |||
| − | |||
:{{CSharp|bool ShowClearButton {get; set;} }} | :{{CSharp|bool ShowClearButton {get; set;} }} | ||
| − | |||
| − | |||
:{{CSharp|bool SubmitOnEnter {get; set;} }} | :{{CSharp|bool SubmitOnEnter {get; set;} }} | ||
| − | |||
| − | |||
:{{CSharp|string Value {get; set;} }} | :{{CSharp|string Value {get; set;} }} | ||
| − | |||
| − | |||
===Events=== | ===Events=== | ||
:{{CSharp|OnSearchChanged()}} | :{{CSharp|OnSearchChanged()}} | ||
| − | |||
| − | |||
:{{CSharp|OnTextChanged()}} | :{{CSharp|OnTextChanged()}} | ||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
:{{CSharp|void AddRecent(string recent)}} | :{{CSharp|void AddRecent(string recent)}} | ||
| − | |||
| − | |||
:{{CSharp|void ClearRecents()}} | :{{CSharp|void ClearRecents()}} | ||
| − | |||
| − | |||
:{{CSharp|int FindRecent(string recent)}} | :{{CSharp|int FindRecent(string recent)}} | ||
| − | |||
| − | |||
:{{CSharp|string GetRecent(int index)}} | :{{CSharp|string GetRecent(int index)}} | ||
| − | |||
| − | |||
:{{CSharp|void RemoveRecent(string recent)}} | :{{CSharp|void RemoveRecent(string recent)}} | ||
| − | |||
| − | |||
:{{CSharp|void SetFocus()}} | :{{CSharp|void SetFocus()}} | ||
| − | |||
| − | |||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ | ||
Revision as of 12:49, 26 May 2017
- Inherits class: GUISelectableComponent
- This is a JavaScript visible object
Remarks [edit]
Properties
- GUIButton ClearButton {get;}
- bool DisplayPreviousResults {get; set;}
- int MaxStoredResults {get; set;}
- int MinimumSearchLength {get; set;}
- string Placeholder {get; set;}
- GUILabel PlaceholderLabel {get;}
- int RecentSearchCount {get;}
- float ResultsDelay {get; set;}
- GUIImageBox SearchIcon {get;}
- bool ShowClearButton {get; set;}
- bool SubmitOnEnter {get; set;}
- string Value {get; set;}
Events
- OnSearchChanged()
- OnTextChanged()
Methods
- void AddRecent(string recent)
- void ClearRecents()
- int FindRecent(string recent)
- string GetRecent(int index)
- void RemoveRecent(string recent)
- void SetFocus()
