Class ButtonComponent
Related to:SoyWar.UIToolkit.Elements
/
Inherits from:objectObjectComponentBehaviourMonoBehaviourUIToolkitComponentUIToolkitComponent<Button>ControlComponent<Button,string>TextComponent<Button>
/
Implemented in:SoyWar.UIToolkit.dll
Implements interfaces:IUIToolkitEvent<Button>IEnumerable<Button>IEnumerable
Description
Component linked toButton.
Syntax
[AddComponentMenu("UI Toolkit/Controls/Button", 12)]
public class ButtonComponent : TextComponent<Button>, IUIToolkitEvent<Button>, IEnumerable<Button>, IEnumerableProperties
| Name | Description |
|---|---|
| OnClickEvent | The event is called when the button is clicked. |
Methods
| Name | Description |
|---|---|
| CheckOnClickEvent(EventBase) | Called to confirm if the button is clicked. |
| OnClick(EventBase) | Called when the button is clicked. |
Extension Methods
Inherited Members
Properties
| Name | Description |
|---|---|
| OnTextChangedEvent | This event is called when the text has changed. |
| OnStateChangedEvent | This event is called when the state has changed. |
| OffEvent | This event is called when an element is removed. |
| OnEvent | This event is called when an element is added. |
| Document | |
| OverrideHost | Chooses a template as host instead of the main document. |
| SearchFrom | Targets children from the parent's container (indirect) or via the hierarchy (direct). |
| Selector | |
| Target | Targets the first, last or all active elements. |
Methods
| Name | Description |
|---|---|
| SetText(string) | Set the text for allTextElementlinked to this component. |
| CheckStateChangedEvent(ChangeEvent<TValue>) | Called to confirm if the state has changed. |
| OnStateChanged(ChangeEvent<TValue>) | Called when the state has changed. |
| GetEnumerator() | |
| Set(TElement) | |
| Unset(TElement) | |
| AddCustomStyles(StyleSheet) | Adds custom style for all targeted elements. |
| AddCustomStyles(params StyleSheet[]) | Adds custom styles for all targeted elements. |
| Count() | Count the number of active elements |
| ForceElementsUpdate() | Forces elements to be updated. |
| RemoveCustomStyles(StyleSheet) | Removes custom style from all targeted elements. |
| RemoveCustomStyles(params StyleSheet[]) | Removes custom styles from all targeted elements. |
| SetSelectorFromText(string) | |
| SetSelectorFromText(string, out string) | |
| Validate() | Checks if the document and the selector is valid. |
Operators
| Name |
|---|
| implicit operator TElement(UIToolkitComponent<TElement>) |