Table of Contents
Enumerations #
| Name | Values |
|---|---|
| FaceStyle | Default |
| Circle |
Constants #
| Name | Type | Value |
|---|
This class exposes no constants.
Events #
| Definition | Description |
|---|---|
| GotFocus() | The button received focus. |
| LostFocus() | The button lost focus. |
| MouseEnter() | The mouse entered the button’s drawable area. |
| MouseExit() | The mouse has left the button’s drawable area. |
| Pressed | Fired when the user clicks the button, or presses SPACE, RETURN, or ENTER while the button has focus. |
Methods #
| Name | Parameters | Return Type | Description |
|---|---|---|---|
| Press | None | None | Raises the Pressed event. |
| SpinnerHide | None | None | Hides the AutoDisable spinner. |
| SpinnerShow | None | None | Shows the AutoDisable spinner. |
Properties #
| Name | Type | Default Value | Description |
|---|---|---|---|
| AutoDisable | Boolean | False | When True, clicking will disable the button before sending data back to the server. Must be re-enabled manually. Used to prevent extraneous clicks. |
| AutoDisableShowSpinner | Boolean | False | When True, a status spinner will be shown while the button is auto-disabled. |
| Cancel | Boolean | False | When True and the user presses the Escape key within its parent without another control first trapping the event, the Pressed event will be raised. |
| Caption | String | “” | The text of the button. |
| Default | Boolean | False | When True and the user presses the Enter key within its parent without another control first trapping the event, the Pressed event will be raised. |
| FaceStyle | GraffitiButton.FaceStyles | GraffitiButton.FaceStyles.Default | Style of button. |
| IconObject | Picture | Nil | Allows the use of a Xojo picture object. |
| IconObjectHeight | Integer | 0 | The size to display the icon as. If you want it to appear to be 16×16, this property value should be 16. |
| IconObjectWidth | Integer | 0 | The size to display the icon as. If you want it to appear to be 16×16, this property value should be 16. |
| IndicatorBackground | WebUIControl.Indicators | Default | The Bootstrap Indicator to use for the background of the button. |
| IndicatorBorder | WebUIControl.Indicators | Default | The Bootstrap Indicator to use for the border of the button. |
| IndicatorSpinner | WebUIControl.Indicators | Default | Bootstrap Indicator to apply to the status spinner. |
| IndicatorText | WebUIControl.Indicators | Default | The Bootstrap Indicator to use for the Text/Icon(s) of the button. |
| TextStyle | WebStyle | The style of the button’s caption. |
Notes #
There are no notes for this control.
Examples #
FontAwesome Icons #
To include FontAwesome icons in your button caption, you should use the FontAwesome identifiers inside angled brackets. For example:
<fa fa-camera> Untitled
IconObject Support #
To include the IconObject value in your button caption, use the icon tag in your caption. For example:
<icon> Untitled