Differences

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

Link to this comparison view

desktop:switch [2018/04/14 16:09]
desktop:switch [2019/10/23 05:53] (current)
Line 1: Line 1:
 +==== Enumerations ====
 +^ Name      ^ Values ​      ^
 +|  | This class exposes no enumerations. |
 +
 +==== Constants ====
 +^ Name      ^ Type     ^ Value       ^
 +| 3D | Integer | 0 |
 +| Flat | Integer | 1 |
 +| Oval3D | Integer | 2 |
 +| OvalFlat | Integer | 3 |
 +| Outset | Integer | 4 |
 +| Dark | Integer | 5 |
 +
 +==== Events ====
 +^ Definition ​     ^ Description ​      ^
 +| ValueChange() | Fired when the value is changed. |
 +
 +==== Methods ====
 +^ Definition ​     ^ Description ​      ^
 +|  | This class does not expose any methods. |
 +
 +==== Properties ====
 +^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
 +| Bold | Boolean | False | Determines whether the value text is drawn in bold. |
 +| BorderColorDark | Color | &​c000000 | Determines the dark border color when UseCustomColors is True. |
 +| BorderColorLight | Color | &​c000000 | Determines the light border color when UseCustomColors is True. |
 +| EnableAnimation | Boolean | True | Sets whether the class value change is animated. |
 +| FalseBGColor | Color | &​c000000 | Sets the background color of the False value. |
 +| FalseText | String | ""​ | The text display in the False value. |
 +| InvertValues | Boolean | False | Swap the True and False values positions. |
 +| Italic | Boolean | False | Determines whether the values’ text is drawn in italics. |
 +| Style | Integer | 0 | Determines the visual style of the class. |
 +| SwitchColor | Color | &​c000000 | Determines the color of the value switch when UseCustomColors is True. |
 +| TextColor | Color | &​cFFFFFF | Sets the color of the value text when UseCustomColors is True. |
 +| TextFont | String | "​System"​ | Sets the font face of the value text. |
 +| TextSize | Integer | 0 | Sets the size of the value text font. |
 +| TrueBGColor | Color | &​c000000 | Determines the background color of the True value when UseCustomColors is True. |
 +| TrueText | String | ""​ | The text displayed as the True value. |
 +| Underline | Boolean | False | Sets whether the values’ text is displayed with an underline. |
 +| UseCustomColors | Boolean | False | Sets whether the class is displayed used the colors defined in properties, or with their defaults. |
 +| Value | Boolean | False | The current value of the Switch. |
 +
 +==== Examples ====
 +There are currently no examples for this class.