Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
desktop:button [2019/02/11 22:03]
agcyphers [Properties]
desktop:button [2019/10/23 06:08] (current)
agcyphers [Enumerations]
Line 33: Line 33:
 | ::: |Vintage AOL = 30 | | ::: |Vintage AOL = 30 |
 | ::: |Dual Grip XP = 31 | | ::: |Dual Grip XP = 31 |
-| ::: |Picture Frame = 32 |+| ::: |PictureFrame ​= 32 |
 | ::: |Keyboard Keys = 33 | | ::: |Keyboard Keys = 33 |
 | ::: |GlassTech = 34 | | ::: |GlassTech = 34 |
Line 76: Line 76:
 ==== Events ==== ==== Events ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| Action( Button as [[http://​developer.xojo.com/​integer|Integer]], X as [[http://​developer.xojo.com/​integer|Integer]], Y as [[http://​developer.xojo.com/​integer|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. |+| 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. | | 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 | | GotFocus() | Fires when the control receives focus |
-| KeyPress( Key as [[http://​developer.xojo.com/​string|String]] ) | Fires when the user presses a key on their keyboard while the control has 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. | | LostFocus() | Fires when the control loses focus. |
 | MouseEnter() | Fires when the mouse enters the control’s bounds. | | MouseEnter() | Fires when the mouse enters the control’s bounds. |
 | MouseExit() | Fires when the mouse leaves the control’s bounds. | | MouseExit() | Fires when the mouse leaves the control’s bounds. |
-| MouseMove( X as [[http://​developer.xojo.com/​integer|Integer]], Y as [[http://​developer.xojo.com/​integer|Integer]] ) | Fires when the mouse is moved over the control. X and Y are the coordinates of the mouse when the event fires. |+| 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. | | Open() | Fires when the control is created. |
  
 ==== Methods ==== ==== Methods ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| Push( MouseButton as [[http://​developer.xojo.com/​integer|Integer]] ) | Signals the control to fire the Action event. | +| Push( MouseButton as Integer ) | Signals the control to fire the Action event. | 
-| StyleCount() as [[http://​developer.xojo.com/​integer|Integer]] | Returns the number of styles currently available for display. For enumeration,​ use StyleCount – 1 | +| StyleCount() as Integer | Returns the number of styles currently available for display. For enumeration,​ use StyleCount – 1 | 
-| StyleName( Index as [[http://​developer.xojo.com/​integer|Integer]] ) | Returns the name of the style corresponding to the Index passed. |+| StyleName( Index as Integer ) | Returns the name of the style corresponding to the Index passed. |
 ==== Properties ==== ==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| BackColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | The background color of the control. | +| BackColor | Color | &​c000000 | The background color of the control. | 
-| BackDown ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | The background color of the control when the mouse is down. | +| BackDown | Color | &​c000000 | The background color of the control when the mouse is down. | 
-| BackOver ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | The background color of the control when the mouse is hovering over it. | +| BackOver | Color | &​c000000 | The background color of the control when the mouse is hovering over it. | 
-| BGPictureDisabled ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | When using style 13, Image Button, this will be the background of the control when it is disabled. | +| BGPictureDisabled | Picture | Nil | When using style 13, Image Button, this will be the background of the control when it is disabled. | 
-| BGPictureDown ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | When using style 13, Image Button, this will be the background of the control when the mouse is down. | +| BGPictureDown | Picture | Nil | When using style 13, Image Button, this will be the background of the control when the mouse is down. | 
-| BGPictureNormal ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | When using style 13, Image Button, this will be the background of the control in an idle state. | +| BGPictureNormal | Picture | Nil | When using style 13, Image Button, this will be the background of the control in an idle state. | 
-| BGPictureOver ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | When using style 13, Image Button, this will be the background of the control when the mouse is hovering over it. | +| 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 | [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines the font weight of the text. | +| Bold | Boolean | False | Determines the font weight of the text. | 
-| BorderColorDark ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Dark border color when the control is in an idle state. | +| BorderColorDark | Color | &​c000000 | Dark border color when the control is in an idle state. | 
-| BorderColorDarkDown ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Dark border color when the mouse is down over the control. | +| BorderColorDarkDown | Color | &​c000000 | Dark border color when the mouse is down over the control. | 
-| BorderColorDarkOver ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Dark border color when the mouse is hovering over the control. | +| BorderColorDarkOver | Color | &​c000000 | Dark border color when the mouse is hovering over the control. | 
-| BorderColorLight ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Light border color of the control in an idle state. | +| BorderColorLight | Color | &​c000000 | Light border color of the control in an idle state. | 
-| BorderColorLightDown ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Light border color when the mouse is down over the control. | +| BorderColorLightDown | Color | &​c000000 | Light border color when the mouse is down over the control. | 
-| BorderColorLightOver ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Light border color when the mouse is hovering over the control. | +| BorderColorLightOver | Color | &​c000000 | Light border color when the mouse is hovering over the control. | 
-| Cancel ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether this control reacts when the user presses the ESC key on it’s window. | +| Cancel | Boolean | False | Determines whether this control reacts when the user presses the ESC key on it’s window. | 
-| CheckBoxBehavior ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Sets whether the control’s state is sticky. | +| CheckBoxBehavior | Boolean | False | Sets whether the control’s state is sticky. | 
-| CheckValue ​| [[http://​developer.xojo.com/​boolean|Boolean]] | &​c000000 | When CheckBoxBehavior is True, this will reflect the current value of the button. | +| CheckValue | Boolean | &​c000000 | When CheckBoxBehavior is True, this will reflect the current value of the button. | 
-| Default ​| [[http://​developer.xojo.com/​boolean|Boolean]] | &​c000000 | Determines whether this control reacts when the user presses the Enter or Return keys on the keyboard. | +| Default | Boolean | &​c000000 | Determines whether this control reacts when the user presses the Enter or Return keys on the keyboard. | 
-| DropDownBackColor ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the background color of the drop down portion of the button in an idle state. | +| DropDownBackColor | Color | &​c000000 | Determines the background color of the drop down portion of the button in an idle state. | 
-| DropDownBackDown ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the background color of the drop down portion of the button when the mouse is down. | +| DropDownBackDown | Color | &​c000000 | Determines the background color of the drop down portion of the button when the mouse is down. | 
-| DropDownBackOver ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the background color of the drop down portion of the button when the mouse is hovering over it. | +| DropDownBackOver | Color | &​c000000 | Determines the background color of the drop down portion of the button when the mouse is hovering over it. | 
-| DropDownBorderDark ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the dark border color of the drop down portion of the control in an idle state. | +| DropDownBorderDark | Color | &​c000000 | Determines the dark border color of the drop down portion of the control in an idle state. | 
-| DropDownBorderDarkDown ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the dark border color of the drop down portion of the control when the mouse is down. | +| DropDownBorderDarkDown | Color | &​c000000 | Determines the dark border color of the drop down portion of the control when the mouse is down. | 
-| DropDownBorderDarkOver ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the dark border color of the drop down portion of the control when the mouse is hovering above it. | +| DropDownBorderDarkOver | Color | &​c000000 | Determines the dark border color of the drop down portion of the control when the mouse is hovering above it. | 
-| DropDownBorderLight ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the light border color of the drop down portion of the control in an idle state. | +| DropDownBorderLight | Color | &​c000000 | Determines the light border color of the drop down portion of the control in an idle state. | 
-| DropDownBorderLightDown ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the light border color of the drop down portion of the control when the mouse is down. | +| DropDownBorderLightDown | Color | &​c000000 | Determines the light border color of the drop down portion of the control when the mouse is down. | 
-| DropDownBorderLightOver ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the light border color of the drop down portion of the control when the mouse is hovering over it. | +| DropDownBorderLightOver | Color | &​c000000 | Determines the light border color of the drop down portion of the control when the mouse is hovering over it. | 
-| DropDownTriangle ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the background color of the drop down disclosure triangle. | +| DropDownTriangle | Color | &​c000000 | Determines the background color of the drop down disclosure triangle. | 
-| DropDownTriangleDown ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the background color of the drop down disclosure triangle when the mouse is down. | +| DropDownTriangleDown | Color | &​c000000 | Determines the background color of the drop down disclosure triangle when the mouse is down. | 
-| DropDownTriangleOver ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Determines the background color of the drop down disclosure triangle when the mouse is hovering over it. | +| DropDownTriangleOver | Color | &​c000000 | Determines the background color of the drop down disclosure triangle when the mouse is hovering over it. | 
-| FontName ​| [[http://​developer.xojo.com/​string|String]] | "​system"​ | Sets the font used to display text in the control. | +| FontName | String | "​system"​ | Sets the font used to display text in the control. | 
-| FontSize ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | Sets the size of the fond used to display text in the control. | +| FontSize | Integer | 0 | Sets the size of the fond used to display text in the control. | 
-| Italic ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether the text will be displayed in italics. | +| Italic | Boolean | False | Determines whether the text will be displayed in italics. | 
-| PictureDisabled ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Sets the icon to be displayed within the button when the control is disabled. | +| PictureDisabled | Picture | Nil | Sets the icon to be displayed within the button when the control is disabled. | 
-| PictureDown ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Sets the icon to be displayed within the button when the mouse is down. | +| PictureDown | Picture | Nil | Sets the icon to be displayed within the button when the mouse is down. | 
-| PictureNormal ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Sets the icon to be displayed within the button when in an idle state. | +| PictureNormal | Picture | Nil | Sets the icon to be displayed within the button when in an idle state. | 
-| PictureOver ​| [[http://​developer.xojo.com/​picture|Picture]] | Nil | Sets the icon to be displayed within the button when the mouse is hovering over it. | +| PictureOver | Picture | Nil | Sets the icon to be displayed within the button when the mouse is hovering over it. | 
-| ShowFocusRect ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines whether the control will draw a focus rectangle when it has focus. |+| 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. | | Style | Styles | 0 | Sets the display style of the control. |
-| Text | [[http://​developer.xojo.com/​string|String]] | ""​ | The text of the button. You can use an ampersand (&) to display an underline on a character to signify a corresponding menu operation. | +| 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 ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of the text when the control is disabled. | +| TextColorDisabled | Color | &​c000000 | Color of the text when the control is disabled. | 
-| TextColorDown ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of the text when the mouse is down. | +| TextColorDown | Color | &​c000000 | Color of the text when the mouse is down. | 
-| TextColorNormal ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of the text when the control is in an idle state. | +| TextColorNormal | Color | &​c000000 | Color of the text when the control is in an idle state. | 
-| TextColorOver ​| [[http://​developer.xojo.com/​color|Color]] | &​c000000 | Color of the text when the mouse is hovering over the control. |+| 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. | | TextPosition | Positions | PositionCenter | Position of the text and picture within the control. |
-| Underline ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Sets the decoration of the text. | +| Underline | Boolean | False | Sets the decoration of the text. | 
-| UseSystemColors ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether the control will use the custom color properties, or the default colors for the styles. |+| UseSystemColors | Boolean | False | Determines whether the control will use the custom color properties, or the default colors for the styles. |
  
 ==== Examples ==== ==== Examples ====
 There are currently no examples for this class. There are currently no examples for this class.