Класс CMFCTasksPane

Дополнительные сведения см. в исходном коде, расположенном в папке VC\atlmfc\src\mfc установки Visual Studio.

Класс CMFCTasksPane реализует список доступных для щелчка элементов (задач).

Синтаксис

class CMFCTasksPane : public CDockablePane

Участники

Открытые конструкторы

Имя Описание
CMFCTasksPane::CMFCTasksPane Формирует объект CMFCTasksPane.

Открытые методы

Имя Описание
CMFCTasksPane::AddGroup Добавляет новую группу задач для элемента управления области задач.
CMFCTasksPane::AddLabel Добавляет новую статическую подпись в указанную группу задач.
CMFCTasksPane::AddMRUFilesList Добавляет в группу задачи, указанные в списке последних использовавшихся файлов (MRU).
CMFCTasksPane::AddPage Добавляет новую страницу в область задач.
CMFCTasksPane::AddSeparator
CMFCTasksPane::AddTask Добавляет новую задачу в указанную группу задач.
CMFCTasksPane::AddWindow Добавляет дочернее окно в область задач.
CMFCTasksPane::CollapseAllGroups
CMFCTasksPane::CollapseGroup Программно сворачивает группу.
CMFCTasksPane::CreateDefaultMiniframe (Переопределения CPane::CreateDefaultMiniframe.)
CMFCTasksPane::CreateMenu Вызывается платформой, чтобы создать меню для кнопки меню "Другие области задач".
CMFCTasksPane::EnableAnimation Включает или отключает анимацию свертывания и развертывания групп задач.
CMFCTasksPane::EnableGroupCollapse Указывает, могут ли быть свернуты группы задач.
CMFCTasksPane::EnableHistoryMenuButtons Включает или отключает раскрывающееся меню в кнопках навигации Next и Previous .
CMFCTasksPane::EnableNavigationToolbar Включает или отключает панель навигации.
CMFCTasksPane::EnableOffsetCustomControls
CMFCTasksPane::EnableScrollButtons Заменяет полосу прокрутки на кнопки прокрутки.
CMFCTasksPane::EnableWrapLabels Включает или отключает перенос слов для меток.
CMFCTasksPane::EnableWrapTasks Включает или отключает перенос слов для задач.
CMFCTasksPane::GetActivePage Возвращает для активной страницы отсчитываемый от нуля индекс.
CMFCTasksPane::GetGroupCaptionHeight Возвращает высоту заголовков групп.
CMFCTasksPane::GetGroupCaptionHorzOffset Возвращает текущее смещение заголовка группы относительно левого и правого края области задач.
CMFCTasksPane::GetGroupCaptionVertOffset Возвращает текущее смещение заголовка группы относительно верхнего и нижнего края области задач.
CMFCTasksPane::GetGroupCount Возвращает общее количество групп.
CMFCTasksPane::GetGroupLocation Возвращает внутренней индекс указанной группы.
CMFCTasksPane::GetGroupVertOffset Возвращает смещение группы по вертикали.
CMFCTasksPane::GetHorzMargin Возвращает горизонтальный интервал между областью задач и краями клиентской области.
CMFCTasksPane::GetNextPages
CMFCTasksPane::GetPageByGroup Получает индекс страницы для указанной группы.
CMFCTasksPane::GetPagesCount Возвращает количество страниц.
CMFCTasksPane::GetPreviousPages
CMFCTasksPane::GetScrollBarCtrl (Переопределения CWnd::GetScrollBarCtrl.)
CMFCTasksPane::GetTask Получает задачу.
CMFCTasksPane::GetTaskCount Возвращает количество элементов задач в указанной группе.
CMFCTasksPane::GetTaskGroup Возвращает группу задач по указанному индексу группы.
CMFCTasksPane::GetTaskLocation Возвращает группу и индекс указанной задачи.
CMFCTasksPane::GetTasksHorzOffset Возвращает смещение задач по горизонтали относительно левого и правого края их родительских групп.
CMFCTasksPane::GetTasksIconHorzOffset
CMFCTasksPane::GetTasksIconVertOffset
CMFCTasksPane::GetVertMargin Возвращает вертикальный интервал между областью задач и краями клиентской области.
CMFCTasksPane::IsAccessibilityCompatible (Переопределяет CDockablePane::IsAccessibilityCompatible.)
CMFCTasksPane::IsAnimationEnabled Указывает, включена ли анимация.
CMFCTasksPane::IsBackButtonEnabled Указывает, доступна ли кнопка перехода назад.
CMFCTasksPane::IsForwardButtonEnabled Указывает, доступна ли кнопка перехода вперед.
CMFCTasksPane::IsGroupCollapseEnabled
CMFCTasksPane::IsHistoryMenuButtonsEnabled Указывает, имеют ли кнопки навигации Next и Previous в раскрывающихся меню.
CMFCTasksPane::IsNavigationToolbarEnabled Указывает, доступна ли панель навигации.
CMFCTasksPane::IsToolBox
CMFCTasksPane::IsWrapLabelsEnabled Указывает, переносятся ли слова в метках области задач.
CMFCTasksPane::IsWrapTasksEnabled Указывает, переносятся ли слова в именах задач области задач.
CMFCTasksPane::LoadState (Переопределения CDockablePane::LoadState.)
CMFCTasksPane::OnCancel
CMFCTasksPane::OnClickTask Вызывается платформой по щелчку элемента в области задач.
CMFCTasksPane::OnOK
CMFCTasksPane::OnPressBackButton Вызывается платформой по нажатию кнопки перехода назад.
CMFCTasksPane::OnPressForwardButton Вызывается платформой по нажатию кнопки перехода вперед.
CMFCTasksPane::OnPressHomeButton Вызывается платформой по нажатию кнопки перехода на домашнюю страницу.
CMFCTasksPane::OnPressOtherButton
CMFCTasksPane::OnSetAccData (Переопределения CBasePane::OnSetAccData.)
CMFCTasksPane::OnUpdateCmdUI (Переопределения CDockablePane::OnUpdateCmdUI.)
CMFCTasksPane::P reTranslateMessage (Переопределения CDockablePane::P reTranslateMessage.)
CMFCTasksPane::RecalcLayout (Переопределения CPane::RecalcLayout.)
CMFCTasksPane::RemoveAllGroups Удаляет все группы на указанной странице.
CMFCTasksPane::RemoveAllPages Удаляет все страницы из области задач, за исключением страницы по умолчанию (первой страницы).
CMFCTasksPane::RemoveAllTasks Удаляет все задачи из группы.
CMFCTasksPane::RemoveGroup Удаляет группу.
CMFCTasksPane::RemovePage Удаляет указанную страницу из области задач.
CMFCTasksPane::RemoveTask Удаляет задачу из группы задач.
CMFCTasksPane::SaveState (Переопределения CDockablePane::SaveState.)
CMFCTasksPane::Serialize (Переопределения CDockablePane::Serialize.)
CMFCTasksPane::SetActivePage Активирует указанную страницу в области задач.
CMFCTasksPane::SetCaption Задает заголовок области задач.
CMFCTasksPane::SetGroupCaptionHeight Задает высоту заголовка группы.
CMFCTasksPane::SetGroupCaptionHorzOffset Задает смещение заголовка группы по горизонтали.
CMFCTasksPane::SetGroupCaptionVertOffset Задает смещение заголовка группы по вертикали.
CMFCTasksPane::SetGroupName Задает имя группы.
CMFCTasksPane::SetGroupTextColor Задает цвет текста для заголовка группы.
CMFCTasksPane::SetGroupVertOffset Задает смещение группы по вертикали.
CMFCTasksPane::SetHorzMargin Задает горизонтальный интервал между областью задач и краями клиентской области.
CMFCTasksPane::SetIconsList Задает список изображений, связанных с задачами.
CMFCTasksPane::SetPageCaption Задает текст заголовка для страницы области задач.
CMFCTasksPane::SetTaskName Задает имя задачи.
CMFCTasksPane::SetTasksIconHorzOffset
CMFCTasksPane::SetTasksIconVertOffset
CMFCTasksPane::SetTaskTextColor Задает цвет текста для задачи.
CMFCTasksPane::SetTasksHorzOffset Задает смещение задач по горизонтали относительно левого и правого краев их родительских групп.
CMFCTasksPane::SetVertMargin Задает вертикальный интервал между областью задач и краями клиентской области.
CMFCTasksPane::SetWindowHeight Задает высоту окна.
CMFCTasksPane::ShowCommandMessageString
CMFCTasksPane::ShowTask Показывает или скрывает задачу.
CMFCTasksPane::ShowTaskByCmdId Показывает или скрывает задачу по ее идентификатору команды.
CMFCTasksPane::Update Обновляет элементы графического пользовательского интерфейса, принадлежащие области задач.

Защищенные методы

Имя Описание
CMFCTasksPane::OnActivateTasksPanePage Вызывается платформой при активации новой страницы области задач.

Замечания

Класс CMFCTasksPane реализует следующие возможности:

  • Группировка элементов и назначение каждой группе заголовка.

  • Свертывание и развертывание групп элементов.

  • Назначение значков элементам области задач.

  • Связь элементов с идентификаторами команд, выполняемых щелчком по этим элементам. При нажатии кнопки WM_COMMAND сообщение отправляется владельцу элемента управления области задач.

Для использования элемента управления CMFCTasksPane в своем приложении выполните следующие действия:

  1. Внедрите объект CMFCTasksPane в класс окна главного фрейма.

  2. При обработке сообщения WM_CREATE вызовите Create метод. Вы можете использовать обычные стили CControlBar . Дополнительные сведения см. в разделе CControlBar::Create.

  3. Вызовите метод CMFCTasksPane::AddGroup, чтобы добавить различные группы.

  4. Вызовите функции CMFCTasksPane::AddTask, CMFCTasksPane::AddLabel или CMFCTasksPane::AddMRUFilesList для добавления новых элементов (задач) в каждую группу.

  5. Вызовите CMFCTasksPane::EnableGroupCollapse , чтобы указать, могут ли сворачиваться группы элементов.

На следующем рисунке показан стандартный элемент управления области задач. Первая группа является специальной группой, и ее подпись является более темным цветом. Третья группа свернута. Последняя группа расположена в нижней части области задач и не имеет заголовка. Последняя задача в этой группе — простая метка:

Example of Task Pane.

Внешний вид области задач можно настроить, перемещая различные поля и меняя смещения. На следующем рисунке разъясняется значение этих переменных:

Custom task group.

Пример

В этом примере демонстрируется создание объекта CMFCTasksPane и использование различных методов класса CMFCTasksPane. В примере показано, как включить сворачивание групп задач, включить раскрывающиеся меню на кнопках навигации Next and Previous, включить кнопки прокрутки вместо полосы прокрутки, включить оболочку слова для текста в метках, задать имя подпись области задач, задать цвет текста для группы подпись и задать горизонтальные и вертикальные поля.

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.

Возвращаемое значение

Отсчитываемый от нуля индекс группы, в которой была добавлена метка, или -1, если группа, указанная nGroup , не существует.

Замечания

Платформа обрабатывает задачи и метки по-разному. Когда пользователь щелкает задачу, платформа выполняет команду. Когда пользователь щелкает метку, команда не выполняется. Дополнительные сведения см. в разделе CMFCTasksPane::AddTask.

CMFCTasksPane::AddMRUFilesList

Добавляет задачу для каждого файла, хранящегося в списке последних использованных файлов (MRU) в группу.

int AddMRUFilesList(
    int nGroup,
    int nMaxFiles = 4);

Параметры

nGroup
[in] Указывает индекс группы. Этот метод добавляет список файлов MRU в группу, указанную этим параметром.

nMaxFiles
[in] Указывает количество файлов, отображаемых в списке файлов MRU.

Возвращаемое значение

Отсчитываемый от нуля индекс группы, в которой был добавлен список файлов MRU, или -1, если группа, указанная nGroup , не существует.

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] Указывает идентификатор команды для выполнения, когда пользователь щелкает задачу. Задача рассматривается как метка, если uiCommandID равно 0.

dwUserData
[in] Указывает определяемые пользователем данные, связанные с задачей.

Возвращаемое значение

Отсчитываемый от нуля индекс группы, в которой была добавлена задача, или -1, если группа, указанная nGroup , не существует.

CMFCTasksPane::AddWindow

Добавляет дочернее окно в область задач.

int AddWindow(
    int nGroup,
    HWND hwndTask,
    int nWndHeight,
    BOOL bAutoDestroyWindow = FALSE,
    DWORD dwUserData = 0);

Параметры

nGroup
[in] Указывает индекс группы, в котором добавляется окно.

hwndTask
[in] Указывает дескриптор добавляемого окна.

nWndHeight
[in] Указывает высоту окна.

bAutoDeskWindow
[in] ЗНАЧЕНИЕ TRUE, чтобы уничтожить окно при удалении задачи; в противном случае — ЗНАЧЕНИЕ FALSE.

dwUserData
[in] Указывает определяемые пользователем данные, связанные с задачей.

Возвращаемое значение

Отсчитываемый от нуля индекс группы, в которой было добавлено окно, или -1, если группа, указанная nGroup , не существует.

Замечания

Вызовите этот метод, чтобы добавить элемент управления в область задач. Например, можно добавить элемент управления редактирования, который работает как панель поиска.

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 для включения раскрывающихся меню на кнопках навигации Next и Previous ; в противном случае — 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] Указывает идентификатор ресурса растрового изображения, содержащего изображения для отображения на панели инструментов.

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.

Возвращаемое значение

ЗНАЧЕНИЕ TRUE, если группа nGroup существует; в противном случае — ЗНАЧЕНИЕ 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] Указывает индекс группы задач.

Возвращаемое значение

Количество задач в указанной группе или 0, если nGroup недопустим.

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] Указывает идентификатор команды для поиска задачи.

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

Указывает, имеют ли кнопки навигации Next и Previous в раскрывающихся меню.

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] Указывает идентификатор команды, связанный с задачей.

dwUserData
[in] Содержит определяемые пользователем данные, связанные с заданной задачей.

Замечания

Платформа вызывает этот метод, когда пользователь щелкает задачу. По умолчанию платформа проверка идентификатор команды, связанный с щелкнувшейся задачей, и, если он не равен нулю, отправляет 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::P reTranslateMessage

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, если функция завершается успешно; ЗНАЧЕНИЕ FALSE, если nGroup или nTask является недопустимым.

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] Указывает идентификатор ресурса списка изображений.

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] Указывает горизонтальное смещение.

Замечания

Горизонтальное смещение — это расстояние в пикселях от левых и правых краев группы.

Если значение равно -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, если высота элемента управления окном была успешно задана; ЗНАЧЕНИЕ FALSE, если nGroup является недопустимым или если hwndTask не существует.

Замечания

Вызовите 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 , чтобы показать или скрыть задачу на основе его идентификатора команды.

CMFCTasksPane::ShowTaskByCmdId

Показывает или скрывает задачу по ее идентификатору команды.

BOOL ShowTaskByCmdId(
    UINT uiCommandID,
    BOOL bShow = TRUE,
    BOOL bRedraw = TRUE);

Параметры

uiCommandID
[in] Указывает идентификатор команды задачи для отображения или скрытия.

bShow
[in] ЗНАЧЕНИЕ TRUE для отображения задачи; Значение FALSE для скрытия задачи.

bRedraw
[in] ЗНАЧЕНИЕ TRUE для перераскрыты области задач; в противном случае — ЗНАЧЕНИЕ FALSE.

Возвращаемое значение

ЗНАЧЕНИЕ TRUE, если задача была успешно показана или скрыта; FALSE, если задача с указанным идентификатором команды не существует.

Замечания

Используйте CMFCTasksPane::ShowTask для отображения или скрытия задачи на основе его идентификатора команды.

CMFCTasksPane::Update

Обновляет все элементы управления в области задач.

virtual void Update();

Замечания

Этот метод обновляет область задач подпись, настраивает полосу прокрутки, изменяет положение всех задач и перерисовывает все элементы управления области задач.

Переопределите этот метод в производном классе, чтобы выполнить пользовательский код при обновлении платформы области задач.

См. также

Диаграмма иерархии
Классы
Класс CMFCTasksPaneTaskGroup
Класс CMFCTasksPaneTask
Класс CMFCOutlookBar
Класс CMFCVisualManager