GetGroup

Description

Gets the group according to the handle in the RibbonBar control.

Applies to

RibbonBar controls

Syntax

controlname.GetGroup ( Long ItemHandle, ref RibbonGroupItem Item )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle of the group you want to get.

Item

A RibbonGroupItem variable in which you want to store the group 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 group to the "MyPanel" panel and then gets a copy of the group according to its handle and stores it in the lr_Group variable.

Integer li_Return
Long ll_Handle_Category, ll_Handle_Panel, ll_Handle_Group
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)
li_Return = rbb_1.GetGroup (ll_Handle_Group, lr_Group)

See also

InsertGroup

InsertGroupFirst

InsertGroupLast

DeleteGroup

SetGroup

GetChildItemByIndex