CMFCTasksPane 类
有关详细信息，请参阅所安装的 Visual Studio 的 C\atlmfc\src\mfc 文件夹中的源代码。
CMFCTasksPane 类实现可点击项（任务）的列表。
语法
class CMFCTasksPane : public CDockablePane
成员
公共构造函数
| 名称 | 描述 |
|---|---|
| CMFCTasksPane::CMFCTasksPane | 构造 CMFCTasksPane 对象。 |
公共方法
受保护方法
| 名称 | 描述 |
|---|---|
| CMFCTasksPane::OnActivateTasksPanePage | 激活新的任务窗格页时，由框架调用。 |
注解
CMFCTasksPane 类实现下列功能：
可以对项进行分组，并且每个项分组均可具有关联的标题。
可以折叠或展开项分组。
可以向任务窗格中的每个项分配一个图标。
可将单个项与在用户单击该项时执行的任务 ID 关联。 单击时，WM_COMMAND 消息会发送给任务窗格控件的所有者。
若要在应用程序中使用 CMFCTasksPane 控件，请执行以下步骤：
将
CMFCTasksPane对象嵌入主框架窗口类。处理 WM_CREATE 消息时，请调用
Create方法。 可以使用常规 CControlBar 样式。 有关详细信息，请参阅CControlBar::Create。调用 CMFCTasksPane::AddGroup 方法以添加不同的组。
调用 CMFCTasksPane::AddTask、CMFCTasksPane::AddLabel 或 CMFCTasksPane::AddMRUFilesList 成员函数，以便将新的项（任务）添加到每个组。
调用 CMFCTasksPane::EnableGroupCollapse 以指定是否可以折叠项组。
下图显示了一个典型的任务窗格控件。 第一组是一个特别的组，其描述文字是较深的颜色。 第三组处于折叠状态。 最后一组与任务窗格的底部对齐且没有标题，而且组中的最后一个任务是一个简单的标签：
可以通过调整各种边距和偏移量来自定义任务窗格的外观。 下图阐明这些变量的含义：
示例
下面的示例演示如何构造 CMFCTasksPane 对象和在 CMFCTasksPane 类中使用各种方法。 该示例显示如何启用任务组的折叠、在“下一步”和“上一步”导航按钮上启用下拉菜单、启用滚动按钮代替滚动条、为标签中的文本启用自动换行、设置任务窗格的描述文字名称、设置组描述文字的文本颜色以及设置水平和垂直边距。
CMFCTasksPane *tPane = new CMFCTasksPane();
tPane->EnableGroupCollapse(true);
tPane->EnableHistoryMenuButtons(true);
tPane->EnableScrollButtons(true);
tPane->EnableWrapLabels(true);
tPane->SetCaption(_T("Task Pane"));
tPane->SetGroupTextColor(0, RGB(0, 0, 128));
tPane->SetHorzMargin(15);
tPane->SetVertMargin(15);
tPane->Update();
继承层次结构
CObject
└ CCmdTarget
└ CWnd
└ CBasePane
└ CPane
└ CDockablePane
└ CMFCTasksPane
要求
标头：afxTasksPane.h
CMFCTasksPane::AddGroup
将新任务组添加到任务窗格控件。
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);
参数
nPageIdx
[in] 指定从零开始的页面索引。
lpszGroupName
[in] 指定组名称。
bBottomLocation
[in] 如果在任务窗格控件底部创建组，则为 TRUE；否则为 FALSE。
bSpecial
[in] 如果将此组标记为“特别”组，则为 TRUE；否则为 FALSE。 有关特别组的详细信息，请参阅 CMFCTasksPane 的“注解”部分。
hIcon
[in] 指定要在组描述文字中显示的图标。
返回值
类维护的组的内部列表中的组的从零开始的索引。
备注
调用此方法以创建一组任务，并将该组添加到任务窗格控件。
框架会在任务窗格控件顶部或底部显示任务组。 框架只能在底部显示一个组；此组必须在最后添加。
CMFCTasksPane::AddLabel
将标签添加到指定的任务组。
int AddLabel(
int nGroup,
LPCTSTR lpszLabelName,
int nTaskIcon = -1,
BOOL bIsBold = FALSE);
参数
nGroup
[in] 指定添加标签的组的索引。
lpszLabelName
[in] 指定标签的名称。
nTaskIcon
[in] 指定要在标签旁边显示的图标。 框架将图标存储在图像列表中。 此参数是该列表中的索引。
bIsBold
[in] 如果以粗体文本显示标签；则为 TRUE；否则为 FALSE。
返回值
添加标签的组的从零开始的索引；如果 nGroup 指定的组不存在，则为 -1。
注解
框架以不同的方式处理任务和标签。 当用户单击任务时，框架将执行命令。 当用户单击标签时，不会执行任何命令。 有关详细信息，请参阅 CMFCTasksPane::AddTask。
CMFCTasksPane::AddMRUFilesList
将存储在最近使用 (MRU) 文件列表中的每个文件的任务添加到组中。
int AddMRUFilesList(
int nGroup,
int nMaxFiles = 4);
参数
nGroup
[in] 指定组的索引。 此方法将 MRU 文件列表添加到此参数指定的组中。
nMaxFiles
[in] 指定要在 MRU 文件列表中显示的文件数。
返回值
添加 MRU 文件列表的组的从零开始的索引；如果 nGroup 指定的组不存在，则为 -1。
CMFCTasksPane::AddPage
将页面添加到任务窗格。
int AddPage(LPCTSTR lpszPageLabel);
参数
lpszPageLabel
[in] 指定页面的标签。
返回值
新页面的从零开始的索引。
CMFCTasksPane::AddSeparator
int AddSeparator(int nGroup);
参数
[in] nGroup
返回值
备注
CMFCTasksPane::AddTask
将任务添加到指定的任务组。
int AddTask(
int nGroup,
LPCTSTR lpszTaskName,
int nTaskIcon = -1,
UINT uiCommandID = 0,
DWORD dwUserData = 0);
参数
nGroup
[in] 指定在其中添加任务的组索引。
lpszTaskName
[in] 指定任务的名称。
nTaskIcon
[in] 指定要在任务旁边显示的图标。 框架将图标存储在图像列表中。 此参数是该列表中的索引。
uiCommandID
[in] 指定用户单击任务时要执行的命令的命令 ID。 如果 uiCommandID 为 0，则任务被视为标签。
dwUserData
[in] 指定要与任务关联的用户定义数据。
返回值
添加任务的组的从零开始的索引；如果 nGroup 指定的组不存在，则为 -1。
CMFCTasksPane::AddWindow
将子窗口添加到任务窗格。
int AddWindow(
int nGroup,
HWND hwndTask,
int nWndHeight,
BOOL bAutoDestroyWindow = FALSE,
DWORD dwUserData = 0);
参数
nGroup
[in] 指定在其中添加窗口的组索引。
hwndTask
[in] 指定要添加的窗口的句柄。
nWndHeight
[in] 指定窗口的高度。
bAutoDestroyWindow
[in] 如果在移除任务时销毁窗口，则为 TRUE；否则为 FALSE。
dwUserData
[in] 指定与任务关联的用户定义数据。
返回值
添加窗口的组的从零开始的索引；如果 nGroup 指定的组不存在，则为 -1。
注解
调用此方法可向任务窗格添加控件。 例如，可以添加功能类似于搜索栏的编辑控件。
CMFCTasksPane::CMFCTasksPane
构造 CMFCTasksPane 对象。
CMFCTasksPane();
CMFCTasksPane::CollapseAllGroups
void CollapseAllGroups(BOOL bCollapse = TRUE);
void CollapseAllGroups(
int nPageIdx,
BOOL bCollapse);
参数
[in] bCollapse
[in] nPageIdx
备注
CMFCTasksPane::CollapseGroup
折叠或展开组。
BOOL CollapseGroup(
CMFCTasksPaneTaskGroup* pGroup,
BOOL bCollapse = TRUE);
BOOL CollapseGroup(
int nGroup,
BOOL bCollapse = TRUE);
参数
pGroup
[in] 指定要折叠的组。
bCollapse
[in] 如果要折叠组，则为 TRUE；如果要展开组，则为 FALSE。
nGroup
[in] 指定要在组内部列表中折叠的组的从零开始的索引。
返回值
如果组成功折叠或展开，则为 TRUE；否则为 FALSE。
注解
折叠的组仅显示组描述文字；任务列表已隐藏。
CMFCTasksPane::CreateDefaultMiniframe
virtual CPaneFrameWnd* CreateDefaultMiniframe(CRect rectInitial);
参数
[in] rectInitial
返回值
备注
CMFCTasksPane::CreateMenu
创建当用户单击“其他任务窗格”菜单按钮时出现的菜单。
HMENU CreateMenu() const;
返回值
新菜单的句柄。
注解
在派生类中替代此方法以自定义任务窗格的菜单。
此方法创建的弹出菜单包含任务窗格中的页面列表。 菜单会在活动页面旁边显示复选标记。
CMFCTasksPane::EnableAnimation
启用或禁用当任务组展开或折叠时出现的动画。
void EnableAnimation(BOOL bEnable = TRUE);
参数
bEnable
[in] 如果启用在任务组展开或折叠时出现的动画，则为 TRUE；否则为 FALSE。
注解
默认情况下，启用在任务组展开或折叠时出现的动画。
CMFCTasksPane::EnableGroupCollapse
指定用户是否可以折叠任务组。
void EnableGroupCollapse(BOOL bEnable);
参数
bEnable
[in] 如果用户可以折叠任务组，则为 TRUE；否则为 FALSE。
备注
折叠的任务组仅显示组描述文字；任务列表已隐藏。
CMFCTasksPane::EnableHistoryMenuButtons
启用“下一步”和“上一步”导航按钮上的下拉菜单。
void EnableHistoryMenuButtons(BOOL bEnable = TRUE);
参数
bEnable
[in] 如果启用“下一步”和“上一步”导航按钮上的下拉菜单，则为 TRUE；否则为 FALSE。
注解
默认情况下，禁用“下一步”和“上一步”按钮上的下拉菜单。
菜单包含用户使用过的任务页的历史记录。
CMFCTasksPane::EnableNavigationToolbar
启用或禁用导航工具栏。
void EnableNavigationToolbar(
BOOL bEnable = TRUE,
UINT uiToolbarBmpRes = 0,
CSize sizeToolbarImage = CSize(0,
0),
CSize sizeToolbarButton = CSize(0,
0));
参数
bEnable
[in] 如果启用导航工具栏，则为 TRUE；否则为 FALSE。
uiToolbarBmpRes
[in] 指定位图的资源 ID，其中包含要显示在工具栏上的图像。
sizeToolbarImage
[in] 指定工具栏图像的大小。
sizeToolbarButton
[in] 指定工具栏按钮的大小。
备注
导航工具栏是框架显示在任务窗格顶部的工具栏。 导航工具栏包含“后退”、“前进”和“主页”导航按钮，以及一个包含可用页面列表的菜单按钮。
默认情况下，框架不显示导航工具栏。 如果未显示导航工具栏，则导航按钮位于停靠栏的描述文字上。
CMFCTasksPane::EnableOffsetCustomControls
void EnableOffsetCustomControls(BOOL bEnable);
参数
[in] bEnable
备注
CMFCTasksPane::EnableScrollButtons
启用滚动按钮，而不是滚动条。
void EnableScrollButtons(BOOL bEnable = TRUE);
参数
bEnable
[in] 如果在任务窗格中显示滚动按钮，而不是滚动条，则为 TRUE；否则为 FALSE。
备注
默认情况下，框架在任务窗格中显示滚动按钮。
CMFCTasksPane::EnableWrapLabels
启用或禁用标签中文本的自动换行。
void EnableWrapLabels(BOOL bEnable = TRUE);
参数
bEnable
[in] 如果将显示在任务窗格中的标签中的文本换行，则为 TRUE；否则为 FALSE。
备注
默认情况下，框架不会将标签中的文本换行。 启用自动换行后，标签中的文本可以显示在多行中。 标签可以包括换行标记，例如 \n，以及下划线标记 &。
CMFCTasksPane::EnableWrapTasks
启用或禁用任务中文本的自动换行。
void EnableWrapTasks(BOOL bEnable = TRUE);
参数
bEnable
[in] 如果将任务窗格中的任务换行，则为 TRUE；否则为 FALSE。
注解
默认情况下，禁用任务换行。
CMFCTasksPane::GetActivePage
返回活动页的从零开始的索引。
int GetActivePage() const;
返回值
活动页面的从零开始的索引。
CMFCTasksPane::GetGroupCaptionHeight
返回组描述文字的高度。
int GetGroupCaptionHeight() const;
返回值
组描述文字的高度（以像素为单位）。
CMFCTasksPane::GetGroupCaptionHorzOffset
返回组描述文字的水平偏移量。
int GetGroupCaptionHorzOffset() const;
返回值
组描述文字的水平偏移量。 水平偏移量是到任务窗格左边缘或右边缘的距离（以像素为单位）。
CMFCTasksPane::GetGroupCaptionVertOffset
返回组描述文字的垂直偏移量。
int GetGroupCaptionVertOffset() const;
返回值
组描述文字相对于任务窗格的上边缘和下边缘的垂直偏移量。
备注
垂直偏移量的默认值为 7 像素。
CMFCTasksPane::GetGroupCount
返回组的总数。
int GetGroupCount() const;
返回值
任务窗格中的总组数。
CMFCTasksPane::GetGroupLocation
返回指定组的内部组索引。
BOOL GetGroupLocation(
CMFCTasksPaneTaskGroup* pGroup,
int& nGroup) const;
参数
pGroup
[in] 指定检索其位置的任务组。
nGroup
[out] 包含任务组的从零开始的索引。
返回值
如果找到任务组，则为 TRUE；否则为 FALSE。
CMFCTasksPane::GetGroupVertOffset
返回组的垂直偏移量。
int GetGroupVertOffset() const;
返回值
组的垂直偏移量（以像素为单位）。
CMFCTasksPane::GetHorzMargin
返回任务窗格与工作区边缘之间的水平间距。
int GetHorzMargin() const;
返回值
任务窗格与工作区边缘之间的水平间距。
备注
任务窗格与工作区边缘之间的默认间距为 12 像素。
CMFCTasksPane::GetNextPages
void GetNextPages(CStringList& lstNextPages) const;
参数
[in] lstNextPages
注解
CMFCTasksPane::GetPageByGroup
检索指定组的页索引。
BOOL GetPageByGroup(
int nGroup,
int& nPage) const;
参数
nGroup
[in] 指定任务组的从零开始的索引。
nPage
[out] 包含指定组的页面索引。 如果任务组仅包含默认页面，则返回值为 0。
返回值
如果组 nGroup 存在，则为 TRUE；否则为 FALSE。
CMFCTasksPane::GetPagesCount
返回页数。
int GetPagesCount() const;
返回值
任务窗格中的页数。
CMFCTasksPane::GetPreviousPages
void GetPreviousPages(CStringList& lstPrevPages) const;
参数
[in] lstPrevPages
注解
CMFCTasksPane::GetScrollBarCtrl
virtual CScrollBar* GetScrollBarCtrl(int nBar) const;
参数
[in] nBar
返回值
备注
CMFCTasksPane::GetTask
检索任务。
CMFCTasksPaneTask* GetTask(
int nGroup,
int nTask) const;
参数
nGroup
[in] 指定包含任务的组的从零开始的索引。
nTask
[in] 指定列表中由 nGroup 指定的任务的从零开始的索引。
返回值
指定索引处的任务。
CMFCTasksPane::GetTaskCount
返回指定组中的任务数。
int GetTaskCount(int nGroup) const;
参数
nGroup
[in] 指定任务组的索引。
返回值
指定组中的任务数；如果 nGroup 无效，则为 0。
CMFCTasksPane::GetTaskGroup
返回指定组索引的任务组。
CMFCTasksPaneTaskGroup* GetTaskGroup(int nGroup) const;
参数
nGroup
[in] 指定要检索的组的从零开始的索引。
返回值
指定索引处的任务组。
CMFCTasksPane::GetTaskLocation
返回指定任务的组和索引。
BOOL GetTaskLocation(
UINT uiCommandID,
int& nGroup,
int& nTask) const;
BOOL GetTaskLocation(
HWND hwndTask,
int& nGroup,
int& nTask) const;
BOOL GetTaskLocation(
CMFCTasksPaneTask* pTask,
int& nGroup,
int& nTask) const;
参数
uiCommandID
[in] 指定要查找的任务的命令 ID。
nGroup
[out] 包含任务的组索引。
nTask
[out] 包含任务组中任务的索引。
hwndTask
[in] 指定与任务关联的窗口。
pTask
[in] 指定要查找的任务。
返回值
如果找到了任务位置，则为 TRUE；如果指定的任务不存在，则为 FALSE。
备注
此方法将检索指定任务的组索引和任务索引。 如果该方法返回 FALSE，则 nGroup 和 nTask 设置为 -1。
CMFCTasksPane::GetTasksHorzOffset
返回任务的水平偏移量。
int GetTasksHorzOffset() const;
返回值
任务相对于其父组的左边缘和右边缘的水平偏移量。
备注
任务的默认水平偏移量为 12 像素。
CMFCTasksPane::GetTasksIconHorzOffset
int GetTasksIconHorzOffset() const;
返回值
注解
CMFCTasksPane::GetTasksIconVertOffset
int GetTasksIconVertOffset() const;
返回值
备注
CMFCTasksPane::GetVertMargin
返回任务窗格与工作区边缘之间的垂直边距。
int GetVertMargin() const;
返回值
任务窗格与工作区边缘之间的垂直边距。
注解
垂直边距是任务窗格与工作区边缘之间的间距。 垂直边距的默认值为 12 像素。
CMFCTasksPane::IsAccessibilityCompatible
virtual BOOL IsAccessibilityCompatible();
返回值
备注
CMFCTasksPane::IsAnimationEnabled
指示动画是否已启用。
BOOL IsAnimationEnabled() const;
返回值
如果用户展开或折叠组时出现的动画处于启用状态，则为 TRUE；否则为 FALSE。
注解
调用 CMFCTasksPane::EnableAnimation 以启用或禁用动画。
CMFCTasksPane::IsBackButtonEnabled
指示“返回”按钮是否已启用。
BOOL IsBackButtonEnabled() const;
返回值
如果启用“返回”按钮，则为 TRUE；否则为 FALSE。
注解
当用户单击“返回”按钮时，框架会显示上一个任务页。
CMFCTasksPane::IsForwardButtonEnabled
指示“前进”按钮是否已启用。
BOOL IsForwardButtonEnabled() const;
返回值
如果启用“前进”按钮，则为 TRUE；否则为 FALSE。
注解
“前进”按钮可在任务页的历史记录中启用向前导航。
CMFCTasksPane::IsGroupCollapseEnabled
BOOL IsGroupCollapseEnabled() const;
返回值
备注
CMFCTasksPane::IsHistoryMenuButtonsEnabled
指示“下一步”和“上一步”导航按钮是否具有下拉菜单。
BOOL IsHistoryMenuButtonsEnabled() const;
返回值
如果“下一步”和“上一步”导航按钮具有下拉菜单，则为 TRUE；否则为 FALSE。
CMFCTasksPane::IsNavigationToolbarEnabled
指示导航工具栏是否已启用。
BOOL IsNavigationToolbarEnabled() const;
返回值
如果启用导航工具栏，则为 TRUE；否则为 FALSE。
CMFCTasksPane::IsToolBox
virtual BOOL IsToolBox() const;
返回值
备注
CMFCTasksPane::IsWrapLabelsEnabled
指示任务窗格是否在标签中换行。
BOOL IsWrapLabelsEnabled() const;
返回值
如果标签中的字词已换行，则为 TRUE；否则为 FALSE。
CMFCTasksPane::IsWrapTasksEnabled
指定框架是否将任务字符串换行。
BOOL IsWrapTasksEnabled() const;
返回值
如果将任务字符串换行，则为 TRUE；否则为 FALSE。
CMFCTasksPane::LoadState
virtual BOOL LoadState(
LPCTSTR lpszProfileName = NULL,
int nIndex = -1,
UINT uiID = (UINT) -1);
参数
[in] lpszProfileName
[in] nIndex
[in] uiID
返回值
备注
CMFCTasksPane::OnActivateTasksPanePage
激活任务窗格页时，由框架调用。
virtual void OnActivateTasksPanePage();
备注
在派生类中替代此方法以自定义任务窗格页面的外观。
CMFCTasksPane::OnCancel
virtual void OnCancel();
备注
CMFCTasksPane::OnClickTask
当用户单击任务窗格中的项时，由框架调用。
virtual void OnClickTask(
int nGroupNumber,
int nTaskNumber,
UINT uiCommandID,
DWORD dwUserData);
参数
nGroupNumber
[in] 指定包含所单击的任务的组的从零开始的索引。
nTaskNumber
[in] 指定所单击的任务的从零开始的索引。
uiCommandID
[in] 指定与任务关联的命令 ID。
dwUserData
[in] 包含与所单击的任务关联的用户定义数据。
备注
当用户单击任务时，框架会调用此方法。 默认情况下，框架会检查与所单击的任务关联的命令 ID，如果不是零，则向任务窗格控件的所有者发送 WM_COMMAND 消息。
在派生类中替代此方法，以在单击任务时执行自定义代码。
CMFCTasksPane::OnOK
virtual void OnOK();
备注
CMFCTasksPane::OnPressBackButton
当用户单击“后退”按钮时，由框架调用。
virtual void OnPressBackButton();
备注
默认情况下，框架会显示以前查看过的页面。
在派生类中替代此方法，以当用户单击“后退”按钮时，执行自定义代码。
CMFCTasksPane::OnPressForwardButton
当用户单击“前进”导航按钮时，由框架调用。
virtual void OnPressForwardButton();
备注
默认情况下，框架会显示在单击“后退”按钮之前用户查看过的页面。
在派生类中替代此方法，以当用户单击“前进”按钮时，执行自定义代码。
CMFCTasksPane::OnPressHomeButton
当用户单击“主页”导航按钮时，由框架调用。
virtual void OnPressHomeButton();
备注
默认情况下，框架会显示任务组的默认页面。
在派生类中替代此方法，以当用户单击“主页”导航按钮时，执行自定义代码。
CMFCTasksPane::OnPressOtherButton
virtual void OnPressOtherButton(
CMFCCaptionMenuButton* pbtn,
CWnd* pWndOwner);
参数
[in] pbtn
[in] pWndOwner
备注
CMFCTasksPane::OnSetAccData
virtual BOOL OnSetAccData(long lVal);
参数
[in] lVal
返回值
备注
CMFCTasksPane::OnUpdateCmdUI
virtual void OnUpdateCmdUI(
CFrameWnd* pTarget,
BOOL bDisableIfNoHndler);
参数
[in] pTarget
[in] bDisableIfNoHndler
备注
CMFCTasksPane::PreTranslateMessage
virtual BOOL PreTranslateMessage(MSG* pMsg);
参数
[in] pMsg
返回值
备注
CMFCTasksPane::RecalcLayout
void RecalcLayout(BOOL bRedraw = TRUE);
参数
[in] bRedraw
注解
CMFCTasksPane::RemoveAllGroups
删除指定页上的所有组。
void RemoveAllGroups(int nPageIdx = 0);
参数
nPageIdx
[in] 指定页面的从零开始的索引。
备注
移除 nPageIdx 指定的页面上的所有组；如果只有默认页面，则移除所有组。
CMFCTasksPane::RemoveAllPages
从任务窗格中删除所有页，除默认（第一）页除外。
void RemoveAllPages();
CMFCTasksPane::RemoveAllTasks
从指定组中移除所有任务。
void RemoveAllTasks(int nGroup);
参数
nGroup
[in] 指定组的从零开始的索引。
CMFCTasksPane::RemoveGroup
删除组。
void RemoveGroup(int nGroup);
参数
nGroup
[in] 指定要移除的组的从零开始的索引。
备注
此方法用于移除单个组。 若要移除所有组，请改为调用 CMFCTasksPane::RemoveAllGroups。
当框架移除组时，将销毁与之关联的所有任务和用户窗口。
CMFCTasksPane::RemovePage
从任务窗格删除指定页。
void RemovePage(int nPageIdx);
参数
nPageIdx
[in] 指定要移除的页面的从零开始的索引。
CMFCTasksPane::RemoveTask
从任务组删除任务。
BOOL RemoveTask(
int nGroup,
int nTask,
BOOL bRedraw = TRUE);
参数
nGroup
[in] 指定包含要移除的任务的任务组的从零开始的索引。
nTask
[in] 指定要移除的任务的从零开始的索引。
bRedraw
[in] 如果重新绘制任务窗格，则为 TRUE；否则为 FALSE。
返回值
如果函数成功，则为 TRUE；如果 nGroup 或 nTask 无效，则为 FALSE。
CMFCTasksPane::SaveState
virtual BOOL SaveState(
LPCTSTR lpszProfileName = NULL,
int nIndex = -1,
UINT uiID = (UINT) -1);
参数
[in] lpszProfileName
[in] nIndex
[in] uiID
返回值
备注
CMFCTasksPane::Serialize
virtual void Serialize(CArchive& ar);
参数
[in] ar
备注
CMFCTasksPane::SetActivePage
使任务窗格中的指定页面处于活动状态。
void SetActivePage(int nPageIdx);
参数
nPageIdx
[in] 指定要显示的页面的从零开始的索引。
注解
此方法断言 nPageIdx 是否无效。
CMFCTasksPane::SetCaption
设置任务窗格的标题名称。
void SetCaption(LPCTSTR lpszName);
参数
lpszName
[in] 指定描述文字名称。
备注
如果任务窗格具有多个页面，则默认页面具有使用此函数设置的描述文字。
CMFCTasksPane::SetGroupCaptionHeight
设置组标题的高度。
void SetGroupCaptionHeight(int n = -1);
参数
n
[in] 指定描述文字高度。
备注
调用此方法以自定义任务窗格元素的边距。
如果 n 为 -1，则框架通过使用虚拟管理器 (CMFCVisualManager::GetTasksPaneGroupCaptionHeight) 来确定边距值。 默认描述文字高度为 25 像素。
CMFCTasksPane::SetGroupCaptionHorzOffset
设置组标题的水平偏移量。
void SetGroupCaptionHorzOffset(int n = -1);
参数
n
[in] 指定组描述文字的水平偏移量。
CMFCTasksPane::SetGroupCaptionVertOffset
设置组标题的垂直偏移量。
void SetGroupCaptionVertOffset(int n = -1);
参数
n
[in] 指定组描述文字的垂直偏移量（以像素为单位）。
CMFCTasksPane::SetGroupName
设置组名称。
BOOL SetGroupName(
int nGroup,
LPCTSTR lpszGroupName);
参数
nGroup
[in] 指定组的从零开始的索引。
lpszGroupName
[in] 指定组的名称。
返回值
如果已成功设置组名称，则为 TRUE；否则为 FALSE。
CMFCTasksPane::SetGroupTextColor
设置组标题的文本颜色。
BOOL SetGroupTextColor(
int nGroup,
COLORREF color,
COLORREF colorHot = (COLORREF)-1);
参数
nGroup
[in] 指定组的从零开始的索引。
color
[in] 指定文本颜色。
colorHot
[in] 指定突出显示的组的文本颜色。 如果为 -1，则使用默认突出显示的颜色。
返回值
如果已成功更改组文本颜色，则为 TRUE；否则为 FALSE。
CMFCTasksPane::SetGroupVertOffset
设置组的垂直偏移量。
void SetGroupVertOffset(int n = -1);
参数
n
[in] 指定垂直偏移量。
注解
垂直偏移量是任务组与任务窗格边框之间的距离。
调用此方法以自定义任务窗格元素的边距。 如果 n 为 -1，则框架通过使用虚拟管理器 (CMFCVisualManager::GetTasksPaneGroupVertOffset) 来确定边距值。 默认偏移量为 15 像素。
CMFCTasksPane::SetHorzMargin
设置水平边距。
void SetHorzMargin(int n = -1);
参数
n
[in] 指定边距（以像素为单位）。
备注
水平边距是任务窗格与工作区的上边缘或下边缘之间的距离。
如果 n 为 -1，则框架通过使用虚拟管理器 (CMFCVisualManager::GetTasksPaneHorzMargin) 来确定边距值。 默认水平边距为 12 像素。
CMFCTasksPane::SetIconsList
设置图像列表。
BOOL SetIconsList(
UINT uiImageListResID,
int cx,
COLORREF clrTransparent = RGB(255, 0, 255));
void SetIconsList(HIMAGELIST hIcons);
参数
uiImageListResID
[in] 指定映像列表的资源 ID。
cx
[in] 指定图像列表中的图标大小。
clrTransparent
[in] 指定透明颜色。
hIcons
[in] 指定包含任务窗格图标的图像列表。
备注
框架将图标存储在图像列表中。 任务与存储在该列表中的图标相关联。
此方法将图像列表与任务窗格控件相关联。 若要在调用 CMFCTasksPane::AddTask 时为任务设置图标，请将 nTaskIcon 设置为此图像列表中相应的从零开始的索引。
CMFCTasksPane::SetPageCaption
设置任务窗格页的标题文本。
void SetPageCaption(
int nPageIdx,
LPCTSTR lpszName);
参数
nPageIdx
[in] 指定页面的从零开始的索引。
lpszName
[in] 指定要在页面上显示的描述文字。
备注
如果任务窗格具有多个页面，则默认页面具有使用此方法设置的描述文字。
CMFCTasksPane::SetTaskName
设置任务的名称。
BOOL SetTaskName(
int nGroup,
int nTask,
LPCTSTR lpszTaskName);
参数
nGroup
[in] 指定任务组的从零开始的索引。
nTask
[in] 指定任务的从零开始的索引。
lpszTaskName
[in] 指定任务名称。
返回值
如果已成功设置任务名称，则为 TRUE；否则为 FALSE。
CMFCTasksPane::SetTasksHorzOffset
设置任务的水平偏移量。
void SetTasksHorzOffset(int n = -1);
参数
n
[in] 指定水平偏移量。
注解
水平偏移量是到组的左边缘和右边缘的距离（以像素为单位）。
如果 n 为 -1，则此方法将水平偏移量设置为 CMFCVisualManager::GetTasksPaneTaskHorzOffset 方法返回的值。
默认水平偏移量为 12 像素。
CMFCTasksPane::SetTasksIconHorzOffset
void SetTasksIconHorzOffset(int n = -1);
参数
[in] n
备注
CMFCTasksPane::SetTasksIconVertOffset
void SetTasksIconVertOffset(int n = -1);
参数
[in] n
注解
CMFCTasksPane::SetTaskTextColor
设置任务的文本颜色。
BOOL SetTaskTextColor(
int nGroup,
int nTask,
COLORREF color,
COLORREF colorHot = (COLORREF)-1);
参数
nGroup
[in] 指定包含任务的任务组的从零开始的索引。
nTask
[in] 指定任务的从零开始的索引。
color
[in] 指定任务的文本颜色。
colorHot
[in] 指定突出显示的组的文本颜色。 如果为 -1，则此方法使用默认突出显示的颜色。
返回值
如果已成功设置任务的文本颜色，则为 TRUE；否则为 FALSE。
CMFCTasksPane::SetVertMargin
设置垂直边距。
void SetVertMargin(int n = -1);
参数
n
[in] 指定要设置的垂直边距。
备注
垂直边距是任务窗格与工作区垂直边缘之间的距离。
如果 n 为 -1，则框架通过使用虚拟管理器 (CMFCVisualManager::GetTasksPaneVertMargin) 来确定边距值。 默认边距为 12 像素。
CMFCTasksPane::SetWindowHeight
设置窗口控件的高度。
BOOL SetWindowHeight(
int nGroup,
HWND hwndTask,
int nWndHeight);
BOOL SetWindowHeight(
HWND hwndTask,
int nWndHeight);
参数
nGroup
[in] 指定包含窗口控件的组的从零开始的索引。
hwndTask
[in] 指定窗口控件的句柄。
nWndHeight
[in] 指定要设置的高度。
返回值
如果已成功设置窗口控件的高度，则为 TRUE；如果 nGroup 无效或 hwndTask 不存在，则为 FALSE。
注解
调用 CMFCTasksPane::AddWindow 以使用窗口控件添加任务。
CMFCTasksPane::ShowCommandMessageString
virtual void ShowCommandMessageString(UINT uiCmdId);
参数
[in] uiCmdId
注解
CMFCTasksPane::ShowTask
显示或隐藏任务。
BOOL ShowTask(
int nGroup,
int nTask,
BOOL bShow = TRUE,
BOOL bRedraw = TRUE);
参数
nGroup
[in] 指定组的从零开始的索引。
nTask
[in] 指定要显示或隐藏的任务的从零开始的索引。
bShow
[in] 如果显示任务，则为 TRUE；如果隐藏窗格，则为 FALSE。
bRedraw
[in] 如果重新绘制任务窗格，则为 TRUE；否则为 FALSE。
返回值
如果已成功显示或隐藏任务，则为 TRUE；如果指定的组或任务不存在，则为 FALSE。
备注
使用 CMFCTasksPane::ShowTaskByCmdId 可基于其命令 ID 显示或隐藏任务。
CMFCTasksPane::ShowTaskByCmdId
基于任务的命令 ID 显示或隐藏任务。
BOOL ShowTaskByCmdId(
UINT uiCommandID,
BOOL bShow = TRUE,
BOOL bRedraw = TRUE);
参数
uiCommandID
[in] 指定要显示或隐藏的任务的命令 ID。
bShow
[in] 如果显示任务，则为 TRUE；如果隐藏窗格，则为 FALSE。
bRedraw
[in] 如果重新绘制任务窗格，则为 TRUE；否则为 FALSE。
返回值
如果已成功显示或隐藏任务，则为 TRUE；如果具有指定命令 ID 的任务不存在，则为 FALSE。
备注
使用 CMFCTasksPane::ShowTask 可基于其命令 ID 显示或隐藏任务。
CMFCTasksPane::Update
刷新任务窗格中的所有控件。
virtual void Update();
备注
此方法将更新任务窗格描述文字，调整滚动条，重新定位所有任务，并重新绘制所有任务窗格控件。
在派生类中替代此方法，以在框架刷新任务窗格时执行自定义代码。
另请参阅
层次结构图
类
CMFCTasksPaneTaskGroup 类
CMFCTasksPaneTask 类
CMFCOutlookBar 类
CMFCVisualManager 类
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈