Share via


CMFCTasksPane::AddGroup

Adds a new group of tasks to the task pane control.

int AddGroup(
    int nPageIdx,
    LPCTSTR lpszGroupName,
    BOOL bBottomLocation = FALSE,
    BOOL bSpecial = FALSE,
    HICON hIcon = NULL
);
int AddGroup(
    LPCTSTR lpszGroupName,
    BOOL bBottomLocation = FALSE,
    BOOL bSpecial = FALSE,
    HICON hIcon = NULL
);

Parameters

  • [in] nPageIdx
    Specifies the zero-based page index.

  • [in] lpszGroupName
    Specifies the group name.

  • [in] bBottomLocation
    TRUE to create the group at the bottom of the task pane control; otherwise, FALSE.

  • [in] bSpecial
    TRUE to mark this group as a special group; otherwise, FALSE. For more information about special groups, see the Remarks section of CMFCTasksPane Class.

  • [in] hIcon
    Specifies the icon to display in the group caption.

Return Value

The zero-based index of the group in the internal list of groups that the class maintains.

Remarks

Call this method to create a group of tasks and to add that group to the task pane control.

The framework displays task groups at the top of the task pane control or at the bottom. The framework can display only one group at the bottom; this group must be added last.

Requirements

Header: afxTasksPane.h

See Also

Reference

CMFCTasksPane Class

Hierarchy Chart