AddGroup()

The AddGroup() function defined in the syListViewCmdBarObj form is used to add an additional group (command list) to the Action Pane for a list.

Syntax

AddGroup(product_ID, list_ID, view_ID, sequence, CmdDictID, CmdFormID, CmdID, caption, visible {, clone})

Parameters

• product_ID – The ID of the dictionary that contains the list for which you are adding a group.

• list_ID – An integer specifying the ID of the list for which you are adding a group.

• view_ID – An integer specifying the view for which the group is being added. Use the constant LIST_PRIMARYVIEWID to indicate the primary view for the list.

• sequence – An integer variable that can be used to specify the sequence of the group in the Action Pane. The value 0 specifies the group will be added to the end of the Action Pane. The actual position of the group will be returned after the group is added.

• CmdDictID – The ID of the dictionary that contains the group (command list) you are adding.

• CmdFormID – The resource ID of the command form that contains the definition of the group (command list) you are adding.

• CmdID – The resource ID of the group (command list) you are adding.

• caption – A string specifying the caption to display for the group when it is displayed in the Action Pane. Set this parameter to the empty string ("").

• visible – A boolean specifying whether the group will initially be visible in the Action Pane. The value true indicates it will be visible, while the value false indicates it will not.

• clone – An optional boolean indicating whether the group should be duplicated for all existing lists of the specified type.

Return value

An integer indicating whether the group was added to the Action Pane. The value corresponds to one of the following constants:

Documentation Feedback

---