XUIImageButton
Inherits DesktopCanvas
Description
A simple canvas-based button. You must ensure that the images selected for this button are the same size as the button as no scaling of the image is performed.
Properties
| Name | Type | Read-Only |
|---|---|---|
| BorderColor | ColorGroup |
|
| DefaultImage | Picture |
|
| DisabledImage | Picture |
|
| HasBottomBorder | Boolean |
|
| HasLeftBorder | Boolean |
|
| HasRightBorder | Boolean |
|
| HasTopBorder | Boolean |
|
| HoverImage | Picture |
|
| IsPressed | Boolean |
|
| mBorderColor | ColorGroup |
|
| mDefaultImage | Picture |
|
| mDisabledImage | Picture |
|
| mHasBottomBorder | Boolean |
|
| mHasLeftBorder | Boolean |
|
| mHasRightBorder | Boolean |
|
| mHasTopBorder | Boolean |
|
| mHoverImage | Picture |
|
| mIsPressed | Boolean |
|
| mMouseOverButton | Boolean |
|
| mPressedImage | Picture |
|
| mType | XUIImageButton.Types |
|
| PressedImage | Picture |
|
| Type | XUIImageButton.Types |
Methods
| Name | Parameters | Returns |
|---|---|---|
| GetCorrectPicture | Picture |
Events
| Name | Parameters | Returns |
|---|---|---|
| Pressed |
Enumerations
Types
The supported types of button.
| Name |
|---|
| PushButton |
| ToggleButton |
Property Descriptions
BorderColor As ColorGroup
If the button has a border, this is its colour.
DefaultImage As Picture
The image to use for the button when in its default state.
DisabledImage As Picture
The image to use for the button when disabled. If not specified, the default image is used.
HasBottomBorder As Boolean
If True then a border is drawn along the bottom edge of the button.
HasLeftBorder As Boolean
If True then a border is drawn along the left edge of the button.
HasRightBorder As Boolean
If True then a border is drawn along the right edge of the button.
HasTopBorder As Boolean
If True then a border is drawn along the top edge of the button.
HoverImage As Picture
The image to use for the button when the mouse is hovering over it. If not specified, the default image is used.
IsPressed As Boolean
True if the button is currently pressed or toggled.
mBorderColor As ColorGroup
If the button has a border, this is its colour.
mDefaultImage As Picture
The image to use for the button when in its default state.
mDisabledImage As Picture
The image to use for the button when disabled. If not specified, the default image is used.
mHasBottomBorder As Boolean
If True then a border is drawn along the bottom edge of the button.
mHasLeftBorder As Boolean
If True then a border is drawn along the left edge of the button.
mHasRightBorder As Boolean
If True then a border is drawn along the right edge of the button.
mHasTopBorder As Boolean
If True then a border is drawn along the top edge of the button.
mHoverImage As Picture
The image to use for the button when the mouse is hovering over it. If not specified, the default image is used.
mIsPressed As Boolean
True if the button is currently being pressed.
mMouseOverButton As Boolean
True if the mouse is over the button.
mPressedImage As Picture
The image to use for the button when in its pressed state. If not specified, the default image is used.
mType As XUIImageButton.Types
The type of button (push or toggle).
PressedImage As Picture
The image to use for the button when in its pressed state. If not specified, the default image is used.
Type As XUIImageButton.Types
The type of button (push or toggle).
Method Descriptions
GetCorrectPicture() As Picture
Returns the correct picture to use for the button's current state.
Event Descriptions
Pressed() The button has been pressed.