Skip to content

XUITextButton

Inherits DesktopCanvas

Description

XUITextButton is a simple, customisable and modern-looking text button.

Properties

Name Type Read-Only
BackgroundColor ColorGroup
FontName String
FontSize Integer
HasBackgroundColor Boolean
IsPressed Boolean
mBackgroundColor ColorGroup
mFontName String
mFontSize Integer
mHasBackgroundColor Boolean
mIsPressed Boolean
mMouseOverButton Boolean
mPressedColor ColorGroup
mPressedTextColor ColorGroup
mTextColor ColorGroup
mTitle String
mType XUITextButton.Types
PressedColor ColorGroup
PressedTextColor ColorGroup
TextColor ColorGroup
Title String
Type XUITextButton.Types

Events

Name Parameters Returns
Pressed

Enumerations

Types

The supported types of button.

Name
PushButton
ToggleButton

Property Descriptions

BackgroundColor As ColorGroup

The colour of the background (if enabled).


FontName As String

The font family to use.


FontSize As Integer

The font size to use.


HasBackgroundColor As Boolean

True if the button has a background colour.


IsPressed As Boolean

True if the button is currently pressed or toggled.


mBackgroundColor As ColorGroup

The colour of the background (if enabled).


mFontName As String

The font family to use.


mFontSize As Integer

The font size to use.


mHasBackgroundColor As Boolean

True if the button has a background colour.


mIsPressed As Boolean

True if the button is currently pressed or toggled.


mMouseOverButton As Boolean

True if the mouse is over the button.


mPressedColor As ColorGroup

The colour of the selection lozenge when the button is pressed.


mPressedTextColor As ColorGroup

The colour of the text when the button is pressed.


mTextColor As ColorGroup

The text colour.


mTitle As String

The button's title.


mType As XUITextButton.Types

The type of button (push or toggle).


PressedColor As ColorGroup

The colour of the selection lozenge when the button is pressed.


PressedTextColor As ColorGroup

The colour of the text when the button is pressed.


TextColor As ColorGroup

The text colour.


Title As String

The button's title.


Type As XUITextButton.Types

The type of button (push or toggle).


Event Descriptions

Pressed() The button has been pressed.