A check box control.
Parent Elements
This element can appear as a child of the following elements.
| Element | Description | Version Introduced | Pro Version Introduced |
|---|---|---|---|
| <Group> | A single group that appears within a single tab and contains controls. | 1.0 | 3.2 |
| <QuickAccessControls> | A list of controls that appear in the quick access toolbar. | 1.0 | 3.2 |
| <SplitButton> | A button control with a drop down that can contain other controls. | 1.0 | 3.2 |
| <TabBarControls> | The list of controls that appear on the right end of the tab bar area. | 1.0 | 3.2 |
Attributes
This element supports the following attributes:
| Attribute | Description | Version Introduced | Pro Version Introduced |
|---|---|---|---|
| BeginGroup | Determines if this control begins a new group. | 1.0 | 3.2 |
| Caption | The text to appear on the control. | 1.0 | 3.2 |
| Key | The unique identifier of this control. Must be unique among all other controls. (Required) | 1.0 | 3.2 |
| KeyboardTip | The keyboard tooltip that appears when the user holds the Alt key. | 1.0 | 3.2 |
| Tooltip | The text to appear when the user hovers over the control. | 1.0 | 3.2 |
BeginGroup
The BeginGroup attribute can be set to "True" or "False". When set to "True", it informs the ribbon that this control should not be grouped with the control before it and should be the first control in a new group. This attribute only works if the control is in a group whose GroupControls attribute is "True".
Caption
The Caption is any custom text you want to appear on the control.
Key
The Key attribute defines the unique identifier you will use in properties, methods, or events to identify this control. This needs to be unique among all other controls, regardless of control type.
KeyboardTip
The KeyboardTip attribute establishes the sequence of keys that trigger this control when the user is holding down the Alt key.
Tooltip
The Tooltip attribute sets the text to appear when the user hovers over the control.
Remarks
The CheckBox element defines a check box that will appear on the ribbon. It works just like the check boxes in OI. When checked, the OnCheckBoxCheck event is fired.
Example
<CheckBox Key="CHB_TEST" Caption="Check Me" KeyboardTip="H" Tooltip="This is a check box." />
