Description
Inserts a recent menu item at the specified position in the application menu.
Applies to
Syntax
controlname.InsertRecentItem ( Long Index, String Text, String Clicked )
|
Argument |
Description |
|---|---|
|
controlname |
The name of the RibbonApplicationMenu control into which you want to insert a recent menu item. |
|
Index |
The index number of the recent menu item before which you are inserting a recent menu item. If index is invalid, an error would occur and this operation would return -1. |
|
Text |
The text that displays in the recent menu item. |
|
Clicked |
The name of the Clicked user event to be bound with the recent menu item. The Clicked user event for the recent menu item (RibbonMenuItem with "Recent(2)" type) must have two long parameters for receiving the handle of the application button and the index number of the recent menu item. For details, see Clicked. |
Return value
Long.
Returns the position of the item 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 "Recent" type (that is RibbonMenuItem with ItemType 2) can be added as a recent menu item.
The recent menu can have only one level; and can contain no more than 9 items.
The user events to be bound with the recent menu item must be defined correctly according to the requirements of RibbonMenuItem. For details, see Clicked and Selected.
Examples
This example inserts a recent menu item "RecentItem1" and binds it with the "Ue_RecentItem1Clicked" user event.
Long ll_Return RibbonApplicationMenu lr_AppMenu ll_Return = lr_AppMenu.InsertRecentItem (1, "RecentItem1", "Ue_RecentItem1Clicked")
See also
