CheckBox element

Article
08/20/2021

Represents a Check Box control.

Usage

<CheckBox
  CommandName = "xs:positiveInteger or xs:string"
  ApplicationDefaults.IsChecked = "Boolean"/>

Attributes

Attribute	Type	Required	Description
ApplicationDefaults.IsChecked	Boolean	No	This attribute is valid only when the CheckBox element is a child of QuickAccessToolbar.ApplicationDefaults. Restricted to one of the following values: Note: The CheckBox does not support a tertiary, or indeterminate, state. (true) Default. (false)
CommandName	xs:positiveInteger or xs:string	No	Associates the element with a Command. (xs:positiveInteger or xs:string) A string, an integer value between 2 and 59999, inclusive, or a hexadecimal value between 0x2 and 0xea5f, inclusive. The value must be unique within the Ribbon XML document. Maximum length: 100 characters.

ApplicationDefaults.IsChecked

Boolean

This attribute is valid only when the CheckBox element is a child of QuickAccessToolbar.ApplicationDefaults.
Restricted to one of the following values:

Note:
The CheckBox does not support a tertiary, or indeterminate, state.

(true)

Default.

(false)

CommandName

xs:positiveInteger or xs:string

Associates the element with a Command.

(xs:positiveInteger or xs:string)

A string, an integer value between 2 and 59999, inclusive, or a hexadecimal value between 0x2 and 0xea5f, inclusive.
The value must be unique within the Ribbon XML document.
Maximum length: 100 characters.

Child elements

There are no child elements.

Parent elements

Element
ControlGroup
DropDownButton
DropDownGallery
Group
MenuGroup
QuickAccessToolbar.ApplicationDefaults
SplitButton
SplitButtonGallery

Remarks

Optional or required, depending on the parent element.

May occur one or more times for each ControlGroup, DropDownButton, DropDownGallery, Group, MenuGroup, QuickAccessToolbar.ApplicationDefaults, SplitButton, or SplitButtonGallery element.

Examples

The following example demonstrates the basic markup for the CheckBox element.

This section of code shows the CheckBox Command declarations.

<Command Name="cmdCheckBoxGroup"
         Symbol="cmdCheckBoxGroup"
         Comment="CheckBox Group"
         LabelTitle="CheckBoxGroup"/>
<Command Name="cmdCheckBox"
         Symbol="cmdCheckBox"
         Comment="CheckBox"
         LabelTitle="CheckBox"/>

This section of code shows the CheckBox control declarations.

<Group CommandName="cmdCheckBoxGroup">
  <CheckBox CommandName="cmdCheckBox"></CheckBox>
</Group>

Element information

Minimum supported system: Windows 7
Can be empty: Yes