A RibbonCheckBoxItem control defines a check box in the RibbonBar control. For more about the check box, see the section called “Introduction to RibbonBar items” in Users Guide.
The RibbonCheckBoxItem control is the child object of the RibbonPanelItem or RibbonGroupItem control (RibbonBar > Category > Panel > [Group >] CheckBox). For the hierarchical structure of the ribbon item controls and how to get and set them, refer to the section called “Accessing the RibbonBar items via PowerScripts” in Users Guide.
This control has no events. But you can create user events and bind them with this control. You can create the Clicked user event and the Selected user event. For how to create the Clicked user event, see Clicked in PowerScript Reference; For how to create the Selected user event, see Selected in PowerScript Reference.
|
RibbonCheckBoxItem property |
Datatype |
Description |
|---|---|---|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
|
Boolean |
Specifies whether the control is checked. |
|
|
String |
Specifies the name of the clicked user event to be bound with the control. |
|
|
Boolean |
Specifies whether the control is enabled (can be clicked). |
|
|
Long |
Identifies the handle associated with the item. |
|
|
String |
Specifies the text to be displayed as a PowerTip for the item. |
|
|
String |
Specifies the text to be displayed as a PowerTip description for the item. |
|
|
RightToLeft |
Boolean |
Unsupported. |
|
String |
Specifies the name of the selected user event to be bound with the control. |
|
|
String |
Specifies the shortcut key for the ribbon check box. |
|
|
String |
Specifies the tag value assigned to the control. |
|
|
String |
Specifies the text that displays in the control. |
|
|
Boolean |
Specifies whether the control is in the third state when the control has been defined to have three states. |
|
|
Boolean |
Specifies whether the control has three states. |
|
|
Boolean |
Specifies whether the control is visible. Values are: TRUE -- Control is visible. FALSE -- Control is not visible. |
|
RibbonCheckBoxItem function |
Datatype returned |
Description |
|---|---|---|
|
String |
Returns the name assigned to the control. |
|
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
|
PowerObject |
Returns a reference to the name of the parent object. |
|
|
Boolean |
Adds the specified event to the end of the event queue for the specified object |
|
|
Integer |
Triggers a specified event in the control and executes the script for the event. |
|
|
Object |
Returns the type of the control. |
