Table of Contents

Enumerations

Name Values
Styles Windows 16-bit = 0
Windows 32-bit = 1
Windows XP = 2
Aqua = 3
KDE2 = 4
Mac Classic = 5
OfficeXP = 6
Gel = 7
3D Hover = 8
Faded = 9
WordPress = 10
FireFox = 11
Oval Popup = 12
Image Button = 13
TabXP = 14
Inset Orb = 15
Plastic Orb = 16
Neon And Steel = 17
InsetRect = 18
Office2003 = 19
Sleek = 20
AYB:Framed = 21
SimpleFlat = 22
Dented = 23
Riveted = 24
Aurora = 25
LongView = 26
LongView Duo = 27
Flock = 28
LongView Trio = 29
Vintage AOL = 30
Dual Grip XP = 31
PictureFrame = 32
Keyboard Keys = 33
GlassTech = 34
Boxed Left = 35
Boxed Right = 36
Pro Outlined Bevel = 37
Glowing Tool = 38
GelCap = 39
Diamonesque = 40
Banded = 41
Electric = 42
Stock = 43
ThinPill = 44
Yahoo! = 45
LongView Quatro = 46
HotNET = 47
LongView Quint = 48
LongView Hexad = 49
Banded Top = 50
Round Media = 51
Soft Bevel XP = 52
Win16 DropDown = 53
FireFox2 Middle = 54
FireFox2 Left = 55
FireFox2 Right = 56
Win32 DropDown = 57
WinXP DropDown = 58
Plastic Middle = 59
Plastic Left = 60
Plastic Right = 61
WinXP DropDown Divided = 62
Soft Bevel XP DropDown = 63
Win7 Default = 64
Positions PositionCenter = 0
PositionLeft = 1
PositionRight = 2

Constants

Name Type Value
This class exposes no constants.

Events

Definition Description
Action( Button as Integer, X as Integer, Y as Integer ) Fires when the user clicks the control. Button is the mouse button which was clicked, 0 for Left, 1 for right. X and Y are the coordinates of the mouse position when clicked.
DropDownClick() Fires when the user clicks the drop down portion of buttons whose style have a drop down button.
GotFocus() Fires when the control receives focus
KeyPress( Key as String ) Fires when the user presses a key on their keyboard while the control has focus.
LostFocus() Fires when the control loses focus.
MouseEnter() Fires when the mouse enters the control’s bounds.
MouseExit() Fires when the mouse leaves the control’s bounds.
MouseMove( X as Integer, Y as Integer ) Fires when the mouse is moved over the control. X and Y are the coordinates of the mouse when the event fires.
Open() Fires when the control is created.

Methods

Definition Description
Push( MouseButton as Integer ) Signals the control to fire the Action event.
StyleCount() as Integer Returns the number of styles currently available for display. For enumeration, use StyleCount – 1
StyleName( Index as Integer ) Returns the name of the style corresponding to the Index passed.

Properties

Name Type Default Value Description
BackColor Color &c000000 The background color of the control.
BackDown Color &c000000 The background color of the control when the mouse is down.
BackOver Color &c000000 The background color of the control when the mouse is hovering over it.
BGPictureDisabled Picture Nil When using style 13, Image Button, this will be the background of the control when it is disabled.
BGPictureDown Picture Nil When using style 13, Image Button, this will be the background of the control when the mouse is down.
BGPictureNormal Picture Nil When using style 13, Image Button, this will be the background of the control in an idle state.
BGPictureOver Picture Nil When using style 13, Image Button, this will be the background of the control when the mouse is hovering over it.
Bold Boolean False Determines the font weight of the text.
BorderColorDark Color &c000000 Dark border color when the control is in an idle state.
BorderColorDarkDown Color &c000000 Dark border color when the mouse is down over the control.
BorderColorDarkOver Color &c000000 Dark border color when the mouse is hovering over the control.
BorderColorLight Color &c000000 Light border color of the control in an idle state.
BorderColorLightDown Color &c000000 Light border color when the mouse is down over the control.
BorderColorLightOver Color &c000000 Light border color when the mouse is hovering over the control.
Cancel Boolean False Determines whether this control reacts when the user presses the ESC key on it’s window.
CheckBoxBehavior Boolean False Sets whether the control’s state is sticky.
CheckValue Boolean &c000000 When CheckBoxBehavior is True, this will reflect the current value of the button.
Default Boolean &c000000 Determines whether this control reacts when the user presses the Enter or Return keys on the keyboard.
DropDownBackColor Color &c000000 Determines the background color of the drop down portion of the button in an idle state.
DropDownBackDown Color &c000000 Determines the background color of the drop down portion of the button when the mouse is down.
DropDownBackOver Color &c000000 Determines the background color of the drop down portion of the button when the mouse is hovering over it.
DropDownBorderDark Color &c000000 Determines the dark border color of the drop down portion of the control in an idle state.
DropDownBorderDarkDown Color &c000000 Determines the dark border color of the drop down portion of the control when the mouse is down.
DropDownBorderDarkOver Color &c000000 Determines the dark border color of the drop down portion of the control when the mouse is hovering above it.
DropDownBorderLight Color &c000000 Determines the light border color of the drop down portion of the control in an idle state.
DropDownBorderLightDown Color &c000000 Determines the light border color of the drop down portion of the control when the mouse is down.
DropDownBorderLightOver Color &c000000 Determines the light border color of the drop down portion of the control when the mouse is hovering over it.
DropDownTriangle Color &c000000 Determines the background color of the drop down disclosure triangle.
DropDownTriangleDown Color &c000000 Determines the background color of the drop down disclosure triangle when the mouse is down.
DropDownTriangleOver Color &c000000 Determines the background color of the drop down disclosure triangle when the mouse is hovering over it.
FontName String “system” Sets the font used to display text in the control.
FontSize Integer 0 Sets the size of the fond used to display text in the control.
Italic Boolean False Determines whether the text will be displayed in italics.
PictureDisabled Picture Nil Sets the icon to be displayed within the button when the control is disabled.
PictureDown Picture Nil Sets the icon to be displayed within the button when the mouse is down.
PictureNormal Picture Nil Sets the icon to be displayed within the button when in an idle state.
PictureOver Picture Nil Sets the icon to be displayed within the button when the mouse is hovering over it.
ShowFocusRect Boolean True Determines whether the control will draw a focus rectangle when it has focus.
Style Styles 0 Sets the display style of the control.
Text String “” The text of the button. You can use an ampersand (&) to display an underline on a character to signify a corresponding menu operation.
TextColorDisabled Color &c000000 Color of the text when the control is disabled.
TextColorDown Color &c000000 Color of the text when the mouse is down.
TextColorNormal Color &c000000 Color of the text when the control is in an idle state.
TextColorOver Color &c000000 Color of the text when the mouse is hovering over the control.
TextPosition Positions PositionCenter Position of the text and picture within the control.
Underline Boolean False Sets the decoration of the text.
UseSystemColors Boolean False Determines whether the control will use the custom color properties, or the default colors for the styles.

Examples

There are currently no examples for this class.