InsertGroup

Description

Inserts a group in the panel of the RibbonBar control.

Applies to

RibbonBar control

Syntax

controlname.InsertGroup ( Long PanelHandle, Long ItemHandleAfter )
controlname.InsertGroup ( Long PanelHandle, Long ItemHandleAfter, RibbonGroupItem Item )

Argument

Description

controlname

The name of the RibbonBar control.

PanelHandle

The handle of the panel into which you want to insert a group.

ItemHandleAfter

The handle of the item (check box, combo box, large button, small button, group) on the same level after which you want to insert the group.

Item

A group 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.

Example 1

This example inserts a group after another in the "MyPanel" panel.

Long ll_Handle_Category, ll_Handle_Panel, ll_Handle_Group, ll_Handle_Group2

ll_Handle_Category = rbb_1.InsertCategoryFirst ("MyCategory")
ll_Handle_Panel = rbb_1.InsertPanelFirst (ll_Handle_Category, "MyPanel", "AddSmall!")
ll_Handle_Group = rbb_1.InsertGroupFirst (ll_Handle_Panel)
ll_Handle_Group2 = rbb_1.InsertGroup (ll_Handle_Panel, ll_Handle_Group)

Example 2

This example defines a group item, specifies its NewLine property, and then inserts it after another group in the "MyPanel" panel.

Long ll_Handle_Category, ll_Handle_Panel, ll_Handle_Group, ll_Handle_Group2
RibbonGroupItem lr_Group

ll_Handle_Category = rbb_1.InsertCategoryFirst ("MyCategory")
ll_Handle_Panel = rbb_1.InsertPanelFirst (ll_Handle_Category, "MyPanel", "AddSmall!")
ll_Handle_Group = rbb_1.InsertGroupFirst (ll_Handle_Panel)
lr_Group.newline = True
ll_Handle_Group2 = rbb_1.InsertGroup (ll_Handle_Panel, ll_Handle_Group, lr_Group)

See also

InsertGroupFirst

InsertGroupLast

DeleteGroup

SetGroup

GetGroup

GetChildItemByIndex