Description
Sets a master menu item for the application menu in the RibbonBar control.
Applies to
RibbonApplicationMenu controls
Syntax
controlname.SetMasterItem ( { Long ParentIndex, } Long Index, RibbonMenuItem Item )
|
Argument |
Description |
|---|---|
|
controlname |
The name of the RibbonApplicationMenu control in which you want to set the master menu item. |
|
ParentIndex (optional) |
The index of the master menu item (RibbonMenuItem) whose submenu item you want to set. If not specified, the master menu item will be set; if specified to a valid value, the submenu item of the master menu item (whose index is ParentIndex) will be set; if specified to an invalid value, an error would occur and this operation would return -1. |
|
Index |
The index for the master menu item or submenu item for which you want to set. If index is invalid, an error would occur and this operation would return -1. |
|
Item |
A RibbonMenuItem item you want to set. Only RibbonMenuItem with "Normal(0)" or "Separator(1)" ItemType is supported. If RibbonMenuItem is with other ItemType such as "Recent(2)", an error would occur and this operation would return -1. |
Return value
Integer.
Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, returns null.
Usage
Only the menu item with the "Normal" or "Separator" type (that is RibbonMenuItem with ItemType 0 or 1) can be added as a master menu item.
The master menu can have no more than two levels.
The user events to be bound with the master menu item must be defined correctly according to the requirements of RibbonMenuItem. For details, see Clicked and Selected.
Examples
This example inserts the "MenuItem" master menu item and the "SubMenuItem" submenu item and then sets values for their properties (including Text, PictureName, Clicked etc.).
Integer li_Return
Long ll_Index,ll_Index2
RibbonApplicationMenu lr_AppMenu
RibbonMenuItem lr_MenuItem1,lr_MenuItem2
ll_Index = lr_AppMenu.InsertMasterItemLast("MenuItem","AddSmall!","Ue_MenuItem1Clicked")
ll_Index2 = lr_AppMenu.InsertMasterItemLast(ll_Index,"SubMenuItem","AddSmall!","Ue_MenuItem11Clicked")
lr_MenuItem1.Text = "Account"
lr_MenuItem1.PictureName = "AccountBig!"
lr_MenuItem1.Clicked = "Ue_AccountMenuItemClicked"
lr_MenuItem2.Text = "Account Settings"
lr_MenuItem2.PictureName = "AccountSettingsBig!"
lr_MenuItem2.Clicked = "Ue_AccountSettingsClicked"
li_Return = lr_AppMenu.SetMasterItem(ll_Index,lr_MenuItem1)
li_Return = lr_AppMenu.SetMasterItem(ll_Index,ll_Index2,lr_MenuItem2)
See also
