CheckBox object (Outlook Forms Script)
Displays the selection state of an item.
Remarks
Use a CheckBox to give the user a choice between two values such as Yes/No, True/False, or On/Off. When the user selects a CheckBox, it displays a special mark (such as an X) and its current setting is Yes, True, or On. If the user does not select the CheckBox, it is empty and its setting is No, False, or Off. Depending on the value of the TripleState property, a CheckBox can also have a Null value.
If a CheckBox is bound to a data source, changing the setting changes the value of that source. A disabled CheckBox shows the current value, but is dimmed and does not allow changes to the value from the user interface.
You can also use check boxes inside a group box to select one or more of a group of related items. For example, you can create an order form that contains a list of available items, with a CheckBox preceding each item. The user can select a particular item or items by checking the corresponding CheckBox.
The default property of a CheckBox is the Value property.
The ListBox also lets you put a check mark by selected options. Depending on your application, you can use the ListBox instead of using a group of CheckBox controls.
Events
| Name | Description |
|---|---|
| Click | Occurs when the user clicks inside the control. |
Properties
| Name | Description |
|---|---|
| Accelerator | Returns or sets the accelerator key for a control. Read/write. |
| Alignment | Returns or sets an Integer that indicates the position of a control relative to its caption. Read/write. |
| AutoSize | Returns or sets a Boolean that specifies whether an object automatically resizes to display its entire contents. Read/write. |
| BackColor | Returns or sets a Long that specifies the background color of the object. Read/write. |
| BackStyle | Returns or sets an Integer that specifies the background style for an object. Read/write. |
| Caption | Returns or sets a String that appears on an object to identify or describe it. Read/write. |
| Enabled | Returns or sets a Boolean that specifies whether a control can receive the focus and respond to user-generated events. Read/write. |
| ForeColor | Returns or sets a Long that specifies the foreground color of an object. Read/write. |
| GroupName | Returns or sets a String that identifies a group of mutually exclusive CheckBox controls. Read/write. |
| Locked | Returns or sets a Boolean that specifies whether a control can be edited. Read/write. |
| MouseIcon | Returns a String that represents the full path name of a custom icon that is to be assigned to the control. Read-only. |
| MousePointer | Returns or sets an Integer that specifies the type of pointer displayed when the user positions the mouse over a particular object. Read/write. |
| Picture | Returns a String that specifies the full path name of a bitmap to display on a control. Read-only. |
| PicturePosition | Returns or sets an Integer that specifies the location of the picture relative to its caption. Read/write. |
| SpecialEffect | Returns or sets an Integer that specifies the visual appearance of an object. Read/write. |
| TextAlign | Returns or sets an Integer that specifies how text is aligned in a control. Read/write. |
| TripleState | Returns or sets a Boolean that determines whether a user can specify, from the user interface, the Null state for a CheckBox. Read/write. |
| Value | Returns or sets a Variant that specifies whether the check box is selected. Read/write. |
| WordWrap | Returns or sets a Boolean that specifies whether the contents of a control automatically wrap at the end of a line and the control expands to fit the text. Read/write. |
Support and feedback
Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.