CMFCTasksPaneTask 类

项目
10/16/2023

CMFCTasksPaneTask 类是表示任务窗格控件 (CMFCTasksPane) 的任务的帮助程序类。任务对象表示任务组 (CMFCTasksPaneTaskGroup) 中的一项。每个任务可具有在用户单击任务和显示在任务名称左侧的图标时框架所执行的命令。

语法

class CMFCTasksPaneTask : public CObject

成员

公共构造函数

名称	描述
CMFCTasksPaneTask::CMFCTasksPaneTask	创建并初始化一个 `CMFCTasksPaneTask` 对象。
`CMFCTasksPaneTask::~CMFCTasksPaneTask`	析构函数。

公共方法

名称	描述
CMFCTasksPaneTask::SetACCData	确定当前任务的辅助功能数据。

数据成员

名称	描述
CMFCTasksPaneTask::m_bAutoDestroyWindow	确定是否自动销毁任务窗口。
CMFCTasksPaneTask::m_bIsBold	确定框架是否以粗体文本绘制任务标签。
CMFCTasksPaneTask::m_dwUserData	包含框架与任务相关联的用户定义数据。如果任务没有关联的数据，则设置为零。
CMFCTasksPaneTask::m_hwndTask	任务窗口的句柄。
CMFCTasksPaneTask::m_nIcon	框架在任务旁边显示的图像的图像列表中的索引。
CMFCTasksPaneTask::m_nWindowHeight	任务窗口的高度。如果任务没有任务窗口，则此值为零。
CMFCTasksPaneTask::m_pGroup	指向此任务所属的 `CMFCTasksPaneTaskGroup` 的指针。
CMFCTasksPaneTask::m_rect	指定任务边框。
CMFCTasksPaneTask::m_strName	任务的名称。
CMFCTasksPaneTask::m_uiCommandID	指定用户单击任务时框架执行的命令的命令 ID。如果此值不是有效的命令 ID，则任务被视为简单标签。

注解

下图显示了包含三个任务的任务组：

Task group, expanded.

注意

如果任务没有有效的命令 ID，则它被视为简单标签。

继承层次结构

CObject

CMFCTasksPaneTask

要求

标头：afxTasksPane.h

CMFCTasksPaneTask::CMFCTasksPaneTask

创建并初始化一个 CMFCTasksPaneTask 对象。

CMFCTasksPaneTask(
    CMFCTasksPaneTaskGroup* pGroup,
    LPCTSTR lpszName,
    int nIcon,
    UINT uiCommandID,
    DWORD dwUserData = 0,
    HWND hwndTask = NULL,
    BOOL bAutoDestroyWindow = FALSE,
    int nWindowHeight = 0);

参数

pGroup
指定任务所属的 CMFCTasksPaneTaskGroup。

lpszName
指定任务的名称。

nIcon
指定图像列表中的任务图像的索引。

uiCommandID
指定单击任务时执行的命令的命令 ID。

dwUserData
用户定义的数据。

hwndTask
指定任务窗口的句柄。

bAutoDestroyWindow
如果为 TRUE，将自动销毁任务窗口。

nWindowHeight
指定任务窗口的高度。

备注

CMFCTasksPaneTask::m_bAutoDestroyWindow

确定是否自动销毁任务窗口。

BOOL m_bAutoDestroyWindow;

备注

设置为 TRUE 以指定应自动销毁任务窗口 (CMFCTasksPaneTask::m_hwndTask)；否则为 FALSE。

CMFCTasksPaneTask::m_bIsBold

确定任务标签是否以粗体文本绘制。

BOOL m_bIsBold;

备注

将此成员设置为 TRUE 以显示任务标签的粗体文本。

CMFCTasksPaneTask::m_dwUserData

包含与任务关联的用户定义的数据。如果没有数据与任务关联，则设置为零。

DWORD m_dwUserData;

备注

CMFCTasksPaneTask::m_hwndTask

任务窗口的句柄。

HWND m_hwndTask;

备注

若要添加任务窗口，请调用 CMFCTasksPane::AddWindow。

CMFCTasksPaneTask::m_nIcon

图像列表中的索引位置，用于标识显示在指定任务旁边的图像。

int m_nIcon;

备注

图片列表由 CMFCTasksPane::SetIconsList 设置。

如果要显示没有图像的任务，请将 m_nIcon 设置为 -1。

CMFCTasksPaneTask::m_nWindowHeight

任务窗口的高度。如果任务没有任务窗口，则此值为零。

int m_nWindowHeight;

注解

CMFCTasksPaneTask::m_pGroup

指向此任务所属的 CMFCTasksPaneTaskGroup 的指针。

CMFCTasksPaneTaskGroup* m_pGroup;

注解

每个任务都必须有一个父组。通过调用 CMFCTasksPane::AddGroup，将组添加到任务窗格。

CMFCTasksPaneTask::m_rect

指定任务边框。

CRect m_rect;

备注

绘制任务时，框架会计算此值。

CMFCTasksPaneTask::m_strName

任务的名称。

CString m_strName;

备注

CMFCTasksPaneTask::m_uiCommandID

指定用户单击任务时执行的命令的命令 ID。如果此值不是有效的命令 ID，则任务被视为简单标签。

UINT m_uiCommandID;

备注

CMFCTasksPaneTask::SetACCData

确定当前任务的辅助功能数据。

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

参数

pParent
[in] 表示当前任务的父窗口。

data
[out] CAccessibilityData 类型的对象，该对象使用当前任务的辅助功能数据进行填充。

返回值

如果已成功将当前任务的辅助功能数据填充到 data 参数，则为 TRUE；否则为 FALSE。

另请参阅

层次结构图
 类
 CObject 类

通过