SetGroup

Description

Sets the group for the RibbonBar control.

Applies to

RibbonBar controls

Syntax

controlname.SetGroup ( Long ItemHandle, RibbonGroupItem Item )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle of the group on the same level that you will set.

Item

A group item you are setting.


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 use the SetItem function to set the group. Refer to SetItem for the difference between SetItem and SetGroup.

Examples

This example inserts a group and then sets the value of the NewLine property of the group.

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.GetChildItemByIndex (ll_Handle_Panel, 1, lr_Group)
If li_Return = 1 Then
 lr_Group.NewLine = true
 li_Return = rbb_1.SetGroup (lr_Group.ItemHandle, lr_Group)
End If

See also

InsertGroup

InsertGroupFirst

InsertGroupLast

DeleteGroup

SetGroup

GetGroup

GetChildItemByIndex