Syntax 3: For RibbonMenu controls

Description

Inserts a menu item as the last item in a ribbon menu.

Applies to

Syntax

controlname.InsertItemLast ( { Long ParentIndex, } String Text, String PictureName, String Clicked )

1	controlname.InsertItemLast ( { Long ParentIndex, } String Text, String PictureName, String Clicked )

controlname.InsertItemLast ( { Long ParentIndex, } RibbonMenuItem Item )

1	controlname.InsertItemLast ( { Long ParentIndex, } RibbonMenuItem Item )

Argument	Description
controlname	The RibbonMenu control into which you want to insert a menu item as the last item.
ParentIndex	The index of the menu item (RibbonMenuItem) into which you want to insert a submenu item. It cannot be an index of a separator (that is RibbonMenuItem with ItemType 1). If not specified, a menu item will be inserted as the last item; if specified to a valid value, a submenu item will be inserted as the last item under the menu item (whose index is ParentIndex); if specified to an invalid value, an error would occur and this operation would return -1.
Text	The text that displays in the menu item or submenu item.
PictureName	The name of the file that contains the picture. The image will be displayed in 16*16 pixels.
Clicked	The name of the Clicked user event to be bound with the menu item. The Clicked user event for the menu item must be defined with the required parameters and types. For details, see Clicked in PowerScript Reference.
Item	A RibbonMenuItem item you want to insert. 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

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 menu items with the “Normal” or “Separator” type (that is
RibbonMenuItem with ItemType 0 or 1) can be added to the RibbonMenu
control.

A RibbonMenu control can contain menu items in no more than two
levels.

The user events to be bound with the menu item must be defined
correctly according to the requirements of RibbonMenuItem. For details,
see Clicked in PowerScript Reference and Selected in PowerScript Reference.

Example 1

This example inserts a “MenuItem1” menu item as the last item and
then inserts two submenu items under “MenuItem1” in the following
display order: “SubMenuItem1”, “SubMenuItem2”.

Long ll_Return,ll_Index
RibbonMenu lr_Menu

ll_Index = lr_Menu.InsertItemLast ("MenuItem1", "AddSmall!", "Ue_MenuItem1Clicked")
ll_Return = lr_Menu.InsertItemLast (ll_Index, "SubMenuItem1", "AddSmall!", "Ue_MenuItem11Clicked")
ll_Return = lr_Menu.InsertItemLast (ll_Index, "SubMenuItem2", "AddSmall!", "Ue_MenuItem12Clicked")

Long ll_Return,ll_Index

RibbonMenu lr_Menu

ll_Index = lr_Menu.InsertItemLast ("MenuItem1", "AddSmall!", "Ue_MenuItem1Clicked")

ll_Return = lr_Menu.InsertItemLast (ll_Index, "SubMenuItem1", "AddSmall!", "Ue_MenuItem11Clicked")

ll_Return = lr_Menu.InsertItemLast (ll_Index, "SubMenuItem2", "AddSmall!", "Ue_MenuItem12Clicked")

Example 2

This example also inserts a “MenuItem1” menu item as the last item
and then inserts two submenu items under “MenuItem1” in the following
display order: “SubMenuItem1”, “SubMenuItem2”. It first defines three
RibbonMenu items (lr_MenuItem1, lr_SubMenuItem1, lr_SubMenuItem2) with
various properties (including binding with the “Ue_MenuItem1Clicked” and
“Ue_MenuItem1Selected” user events), and then inserts lr_MenuItem1 as
the last menu item “MenuItem1”, and inserts the other two as the submenu
items under “MenuItem1” in the following display order: “SubMenuItem1”,
“SubMenuItem2”.

Long ll_Return, ll_Index
RibbonMenu lr_Menu
RibbonMenuItem lr_MenuItem1, lr_SubMenuItem1, lr_SubMenuItem2

lr_MenuItem1.Text = "MenuItem1"
lr_MenuItem1.PictureName = "AddSmall!"
lr_MenuItem1.Clicked = "Ue_MenuItem1Clicked"
lr_MenuItem1.Selected = "Ue_MenuItem1Selected"
lr_SubMenuItem1.Text = "SubMenuItem1"
lr_SubMenuItem2.Text = "SubMenuItem2"

ll_Index = lr_Menu.InsertItemLast (lr_MenuItem1)
ll_Return = lr_Menu.InsertItemLast (ll_Index, lr_SubMenuItem1)
ll_Return = lr_Menu.InsertItemLast (ll_Index, lr_SubMenuItem2)