Description
Inserts a check box in the panel or group of the RibbonBar control.
Applies to
RibbonBar controls
Syntax
controlname.InsertCheckBox ( Long ParentHandle, Long ItemHandleAfter, String Text, String Clicked )
controlname.InsertCheckBox ( Long ParentHandle, Long ItemHandleAfter, RibbonCheckBoxItem Item )
|
Argument |
Description |
|---|---|
|
controlname |
The name of the RibbonBar control. |
|
ParentHandle |
The handle of the panel or group in which you want to insert a check box. |
|
ItemHandleAfter |
The handle of the item (check box, combo box, large button, small button, or group) on the same level after which you want to insert the check box. |
|
Text |
The text that displays in the check box. |
|
Clicked |
The name of the Clicked user event to be bound with the check box. The Clicked user event for the check box must have a long parameter for receiving the handle of the check box. For details, see Clicked. |
|
Item |
A check box item to be inserted. |
Return value
Long.
Returns the handle of the inserted item if it succeeds and -1 if an error occurs. If any argument's value is null, returns null.
Usage
The user events to be bound with the check box must be defined correctly according to the requirements of RibbonCheckBoxItem. For details, see Clicked and Selected.
Example 1
This example inserts the "Print Using XSLFOP" check box after the "Distill Custom PostScript" check box and binds both check boxes with the "Ue_CheckBoxClicked" user event.
Long ll_Handle_Category, ll_Handle_Panel, ll_Handle_CheckBox, ll_Handle_CheckBox2
ll_Handle_Category = rbb_1.InsertCategoryFirst ("MyCategory")
ll_Handle_Panel = rbb_1.InsertPanelFirst (ll_Handle_Category, "MyPanel", "AddSmall!")
ll_Handle_CheckBox = rbb_1.InsertCheckBoxFirst (ll_Handle_Panel, "Distill Custom PostScript", "Ue_CheckBoxClicked")
ll_Handle_CheckBox2 = rbb_1.InsertCheckBox (ll_Handle_Panel, ll_Handle_CheckBox, "Print Using XSLFOP", "Ue_CheckBoxClicked")
//Ue_CheckBoxClicked user event must have a long parameter for receiving the handle
//of CheckBox where the mouse is clicking.
//event type long ue_checkboxclicked(long itemhandle);
//RibbonCheckBoxItem lr_CheckBox
//rbb_1.GetCheckBox(ItemHandle,lr_CheckBox)
////...
//
//Return 1
//end event
Example 2
This example inserts the "Print Using XSLFOP" check box after the "Distill Custom PostScript" check box and binds it with the "Ue_CheckBoxClicked" and "Ue_CheckBoxSelected" user events. It first defines a check box item with various properties (including Text, Clicked, Selected etc.) and then inserts it after the "Distill Custom PostScript" check box.
Long ll_Handle_Category,ll_Handle_Panel,ll_Handle_CheckBox,ll_Handle_CheckBox2
RibbonCheckBoxItem lr_CheckBox
ll_Handle_Category = rbb_1.InsertCategoryFirst ("MyCategory")
ll_Handle_Panel = rbb_1.InsertPanelFirst (ll_Handle_Category, "MyPanel", "AddSmall!")
ll_Handle_CheckBox = rbb_1.InsertCheckBoxFirst (ll_Handle_Panel, "Distill Custom PostScript", "Ue_CheckBoxClicked")
lr_CheckBox.Text = "Print Using XSLFOP"
lr_CheckBox.Clicked = "Ue_CheckBoxClicked"
lr_CheckBox.Selected = "Ue_CheckBoxSelected"
ll_Handle_CheckBox2 = rbb_1.InsertCheckBox (ll_Handle_Panel, ll_Handle_CheckBox, lr_CheckBox)
//Ue_CheckBoxSelected user event must have a long parameter for receiving the handle
//of CheckBox where the mouse is hovering over.
//event type long ue_checkboxselected(long itemhandle);
//RibbonCheckBoxItem lr_CheckBox
//rbb_1.GetCheckBox(ItemHandle,lr_CheckBox)
////...
//
//Return 1
//end event
See also
