Differences

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

Link to this comparison view

desktop:optionbox [2019/10/23 05:53] (current)
Line 1: Line 1:
 +==== See Also ====
 +This class has no related objects.
  
 +==== Enumerations ====
 +^ Name      ^ Values ​      ^
 +| Positions | Left |
 +| ::: | Right |
 +| Types  | CheckBox |
 +| ::: | RadioButton |
 +| ::: | Custom |
 +| Values | Unchecked |
 +| ::: | Checked |
 +| ::: | Indeterminate |
 +
 +==== Constants ====
 +^ Name      ^ Type     ^ Value       ^
 +This class exposes no constants.
 +
 +==== Events ====
 +^ Definition ​     ^ Description ​      ^
 +| Clicked() | Raised when the user clicks the component. |
 +| ValueChanged() | Raised when the value of the component has changed. |
 +
 +==== Methods ====
 +^ Definition ​     ^ Description ​      ^
 +This class exposes no methods.
 +
 +==== Properties ====
 +^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
 +| BackgroundColor | Color | &​c000000 | Background color applied to the component. |
 +| Bold | Boolean | False | Font weight of the component'​s text. |
 +| BorderColor | Color | &​c000000 | Color applied to the component'​s text. |
 +| Caption | String | "​Untitled"​ | Text of the component. |
 +| IconChecked | Picture | Nil | Picture to draw when the value is True. Applies only when Type = Custom. |
 +| IconIndeterminate | Picture | Nil | Picture to draw when the value is Indeterminate. Applies only when Type = Custom. |
 +| IconUnchecked | Picture | Nil | Picture to draw when the value is False. Applies on when Type = Custom. |
 +| Italic | Boolean | False | When True, Caption is draw italicized. |
 +| RadioGroupName | String | ""​ | When filled, the component will be part of a group and will scan for other members in its direct parent to change their value as its value changes. |
 +| ShiftValueIcons | Boolean | True | When True, the component will attempt to shift icons to match the current system theme. |
 +| SystemColors | Boolean | True | When False, the component will use the custom color properties for drawing. |
 +| TextColor | Color | &​c000000 | Color used to draw the Caption. |
 +| TextFont | String | "​System"​ | Font face used to draw the Caption. |
 +| TextSize | Integer | 0 | Font size used to draw the Caption. |
 +| Type | Types | CheckBox | The type of component to draw. |
 +| Underline | Boolean | False | When True, Caption will be drawn underlined. |
 +| Value | Values | Unchecked | The current Value of the component. Use Values Enumeration. |
 +| ValueB | Boolean | False | Boolean value matching Values Enumeration. |
 +| ValueColor | Color | &​c000000 | Color applied to the value icon. |
 +| ValuePosition | Positions | Left | Determines the position of the Value icon relative to the Caption. |
 +
 +==== Examples ====
 +This class currently has no examples.
 +
 +==== Notes ====
 +This class currently has no notes.