Description
Gets the check box according to the handle in the RibbonBar control.
Applies to
RibbonBar controls
Syntax
controlname.GetCheckBox ( Long ItemHandle, ref RibbonCheckBoxItem Item )
|
Argument |
Description |
|---|---|
|
controlname |
The name of the RibbonBar control. |
|
ItemHandle |
The handle for the check box you want to obtain. |
|
Item |
A RibbonCheckBoxItem variable in which you want to store the check box identified by the item handle. |
Return value
Integer.
Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, returns null.
Usage
You can also get an item according to the handle by using the GetItem function.
Examples
The following code example inserts a "MyCheckBox" check box to the
"MyPanel" panel and then gets a copy of the check box according to its
handle and stores it in the lr_CheckBox variable.
Integer li_Return
Long ll_Handle_Category, ll_Handle_Panel, ll_Handle_CheckBox
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, "MyCheckBox", "Ue_CheckBoxClicked")
li_Return = rbb_1.GetCheckBox (ll_Handle_CheckBox, lr_CheckBox)
See also
