Структура TASKDIALOGCONFIG (commctrl.h)

Статья
08/22/2023

Структура TASKDIALOGCONFIG содержит сведения, используемые для отображения диалогового окна задачи. Функция TaskDialogIndirect использует эту структуру.

Синтаксис

typedef struct _TASKDIALOGCONFIG {
  UINT                           cbSize;
  HWND                           hwndParent;
  HINSTANCE                      hInstance;
  TASKDIALOG_FLAGS               dwFlags;
  TASKDIALOG_COMMON_BUTTON_FLAGS dwCommonButtons;
  PCWSTR                         pszWindowTitle;
  union {
    HICON  hMainIcon;
    PCWSTR pszMainIcon;
  } DUMMYUNIONNAME;
  PCWSTR                         pszMainInstruction;
  PCWSTR                         pszContent;
  UINT                           cButtons;
  const TASKDIALOG_BUTTON        *pButtons;
  int                            nDefaultButton;
  UINT                           cRadioButtons;
  const TASKDIALOG_BUTTON        *pRadioButtons;
  int                            nDefaultRadioButton;
  PCWSTR                         pszVerificationText;
  PCWSTR                         pszExpandedInformation;
  PCWSTR                         pszExpandedControlText;
  PCWSTR                         pszCollapsedControlText;
  union {
    HICON  hFooterIcon;
    PCWSTR pszFooterIcon;
  } DUMMYUNIONNAME2;
  PCWSTR                         pszFooter;
  PFTASKDIALOGCALLBACK           pfCallback;
  LONG_PTR                       lpCallbackData;
  UINT                           cxWidth;
} TASKDIALOGCONFIG;

Члены

cbSize

Тип: UINT

Задает размер структуры в байтах.

hwndParent

Тип: HWND

Дескриптор родительского окна. Этот элемент может иметь значение NULL.

hInstance

Тип: HINSTANCE

Дескриптор модуля, который содержит ресурс значка, определенный членами pszMainIcon или pszFooterIcon , и строковые ресурсы, определяемые элементами pszWindowTitle, pszMainInstruction, pszContent, pszVerificationText, pszExpandedInformation, pszExpandedControlText, pszCollapsedControlText или pszFooter .

dwFlags

Тип: TASKDIALOG_FLAGS

Указывает поведение диалогового окна задачи. Этот параметр может быть сочетанием флагов из следующей группы:

Значение	Значение
TDF_ENABLE_HYPERLINKS	Включает обработку гиперссылок для строк, указанных в элементах pszContent, pszExpandedInformation и pszFooter . Если этот параметр включен, эти элементы могут указывать на строки, содержащие гиперссылки в следующей форме: `<A HREF="executablestring">Hyperlink Text</A>` Предупреждение. Включение гиперссылок при использовании содержимого из небезопасного источника может привести к уязвимостям системы безопасности. Примечание Диалоговые окна задач на самом деле не будут выполнять гиперссылки. Выполнение гиперссылки должно обрабатываться в функции обратного вызова, указанной в pfCallback. Дополнительные сведения см. в разделе TaskDialogCallbackProc.
TDF_USE_HICON_MAIN	Указывает, что в диалоговом окне в качестве основного значка в диалоговом окне задачи должен использоваться значок, на который ссылается дескриптор элемента hMainIcon . Если этот флаг указан, элемент pszMainIcon игнорируется.
TDF_USE_HICON_FOOTER	Указывает, что диалоговое окно должно использовать значок, на который ссылается дескриптор в элементе hFooterIcon , в качестве значка нижнего колонтитула в диалоговом окне задачи. Если этот флаг указан, элемент pszFooterIcon игнорируется.
TDF_ALLOW_DIALOG_CANCELLATION	Указывает, что диалоговое окно должно быть закрыто с помощью клавиш ALT-F4, Escape и кнопки закрытия заголовка строки, даже если в элементах dwCommonButtons или pButtons не указана кнопка отмены.
TDF_USE_COMMAND_LINKS	Указывает, что кнопки, указанные в элементе pButtons , должны отображаться в виде командных ссылок (с помощью стандартного глифа диалогового окна задачи), а не кнопок push. При использовании командных ссылок все символы до первого нового символа строки в элементе pszButtonText будут рассматриваться как main текст командной ссылки, а остальные символы — как заметка командной ссылки. Этот флаг игнорируется, если элемент cButtons равен нулю.
TDF_USE_COMMAND_LINKS_NO_ICON	Указывает, что кнопки, указанные в элементе pButtons , должны отображаться в виде командных ссылок (без глифа), а не push-кнопок. При использовании командных ссылок все символы до первого нового символа строки в элементе pszButtonText будут рассматриваться как main текст командной ссылки, а остальные символы — как заметка командной ссылки. Этот флаг игнорируется, если элемент cButtons равен нулю.
TDF_EXPAND_FOOTER_AREA	Указывает, что строка, указанная элементом pszExpandedInformation , отображается в нижней части области нижнего колонтитула диалогового окна, а не сразу после содержимого диалога. Этот флаг игнорируется, если элемент pszExpandedInformation имеет значение NULL.
TDF_EXPANDED_BY_DEFAULT	Указывает, что строка, указанная элементом pszExpandedInformation , отображается при первоначальном отображении диалогового окна. Этот флаг игнорируется, если элемент pszExpandedInformation имеет значение NULL.
TDF_VERIFICATION_FLAG_CHECKED	Указывает, что флажок проверки в диалоговом окне установлен при первоначальном отображении диалогового окна. Этот флаг игнорируется, если параметр pszVerificationText имеет значение NULL.
TDF_SHOW_PROGRESS_BAR	Указывает, что должен отображаться индикатор выполнения.
TDF_SHOW_MARQUEE_PROGRESS_BAR	Указывает, что должен отображаться индикатор хода выполнения .
TDF_CALLBACK_TIMER	Указывает, что обратный вызов диалогового окна задачи должен вызываться примерно каждые 200 миллисекунда.
TDF_POSITION_RELATIVE_TO_WINDOW	Указывает, что диалоговое окно задачи расположено (по центру) относительно окна, указанного hwndParent. Если флаг не указан (или элемент hwndParent не указан), диалоговое окно задачи размещается (по центру) относительно монитора.
TDF_RTL_LAYOUT	Указывает, что текст отображается справа налево.
TDF_NO_DEFAULT_RADIO_BUTTON	Указывает, что элемент по умолчанию не будет выбран.
TDF_CAN_BE_MINIMIZED	Указывает, что диалоговое окно задачи можно свернуть.
TDIF_SIZE_TO_CONTENT	Этот флаг является нерекомендуемой. Вместо этого используйте TDF_SIZE_TO_CONTENT .
TDF_SIZE_TO_CONTENT	Указывает, что ширина диалогового окна задачи определяется шириной области содержимого. Этот флаг игнорируется, если для cxWidth не задано значение 0.

dwCommonButtons

Тип: TASKDIALOG_COMMON_BUTTON_FLAGS

Указывает кнопки, отображаемые в диалоговом окне задачи. Если общие кнопки не указаны и пользовательские кнопки не указаны с помощью элементов cButtons и pButtons , диалоговое окно задачи будет содержать кнопку ОК по умолчанию. Этот параметр может быть сочетанием флагов из следующей группы:

Значение	Значение
TDCBF_OK_BUTTON	Диалоговое окно задачи содержит кнопку " ОК".
TDCBF_YES_BUTTON	Диалоговое окно задачи содержит кнопку push: Да.
TDCBF_NO_BUTTON	Диалоговое окно задачи содержит кнопку " Нет".
TDCBF_CANCEL_BUTTON	Диалоговое окно задачи содержит кнопку " Отмена". Если эта кнопка указана, диалоговое окно задачи будет реагировать на типичные действия отмены (ALT-F4 и Escape).
TDCBF_RETRY_BUTTON	Диалоговое окно задачи содержит кнопку "Повторить".
TDCBF_CLOSE_BUTTON	Диалоговое окно задачи содержит кнопку " Закрыть".

pszWindowTitle

Тип: PCWSTR

Указатель, который ссылается на строку, используемую для заголовка диалогового окна задачи. Этот параметр может быть строкой, завершаемой null, или целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE . Если этот параметр имеет значение NULL, используется имя файла исполняемой программы.

DUMMYUNIONNAME

DUMMYUNIONNAME.hMainIcon

Тип: HICON

Дескриптор значка, который должен отображаться в диалоговом окне задачи. Этот элемент игнорируется, если не указан флаг TDF_USE_HICON_MAIN. Если этот элемент имеет значение NULL и указан TDF_USE_HICON_MAIN, значок не отображается.

DUMMYUNIONNAME.pszMainIcon

Тип: PCWSTR

Указатель, который ссылается на значок, отображаемый в диалоговом окне задачи. Этот параметр игнорируется, если указан флаг USE_HICON_MAIN. В противном случае, если этот параметр имеет значение NULL или параметр hInstance имеет значение NULL, значок не будет отображаться. Этот параметр должен быть целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE , или одним из следующих предопределенных значений:

Значение	Значение
TD_ERROR_ICON	В диалоговом окне задачи появится значок стоп-знака.
TD_WARNING_ICON	В диалоговом окне задачи появится значок восклицательного знака.
TD_INFORMATION_ICON	В диалоговом окне задачи появляется значок, состоящий из строчной буквы i в круге.
TD_SHIELD_ICON	В диалоговом окне задачи появится значок щита.

pszMainInstruction

Тип: PCWSTR

Указатель, который ссылается на строку, используемую для инструкции main. Этот параметр может быть строкой, завершаемой null, или целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE .

pszContent

Тип: PCWSTR

Указатель, который ссылается на строку, используемую для основного содержимого диалога. Этот параметр может быть строкой, завершаемой null, или целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE . Если для элемента dwFlags указан флаг ENABLE_HYPERLINKS, то эта строка может содержать гиперссылки в виде: <A HREF="executablestring">Hyperlink Text</A>. ПРЕДУПРЕЖДЕНИЕ. Включение гиперссылок при использовании содержимого из небезопасного источника может привести к уязвимостям системы безопасности.

cButtons

Тип: UINT

Количество записей в массиве pButtons, используемых для создания кнопок или командных ссылок в диалоговом окне задачи. Если этот элемент равен нулю и с помощью элемента dwCommonButtons не указаны общие кнопки, в диалоговом окне задачи будет отображаться одна кнопка ОК .

pButtons

Тип: const TASKDIALOG_BUTTON*

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

nDefaultButton

Тип: int

Кнопка по умолчанию для диалогового окна задачи. Это может быть любое из значений, указанных в элементах nButtonID одной из структур TASKDIALOG_BUTTON в массиве pButtons , или один из идентификаторов, соответствующих кнопкам, указанным в элементе dwCommonButtons :

IDCANCEL	Установите кнопку Отмена по умолчанию.
IDNO	Установите кнопку Нет по умолчанию.
IDOK	Установите кнопку ОК по умолчанию.
IDRETRY	Установите кнопку Повторить по умолчанию.
IDYES	Установите кнопку Да по умолчанию.
IDCLOSE	Установите кнопку Закрыть по умолчанию.

Если этот элемент равен нулю или его значение не соответствует ни одному идентификатору кнопки в диалоговом окне, то первая кнопка в диалоговом окне будет использоваться по умолчанию.

cRadioButtons

Тип: UINT

Количество записей в массиве pRadioButtons , который используется для создания переключателей в диалоговом окне задачи.

pRadioButtons

Тип: const TASKDIALOG_BUTTON*

Указатель на массив TASKDIALOG_BUTTON структур, содержащих определение переключателей, которые должны отображаться в диалоговом окне задачи. Этот массив должен содержать по крайней мере количество записей, указанных элементом cRadioButtons . Этот параметр может принимать значение NULL.

nDefaultRadioButton

Тип: int

Идентификатор переключателя, выбранного по умолчанию. Если это значение не соответствует идентификатору кнопки, первая кнопка в массиве выбирается по умолчанию.

pszVerificationText

Тип: PCWSTR

Указатель, который ссылается на строку, используемую для пометки флажка проверки. Этот параметр может быть строкой, завершаемой null, или целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE . Если этот параметр имеет значение NULL, флажок проверки не отображается в диалоговом окне задачи. Если параметр pfVerificationFlagCheckedобъекта TaskDialogIndirect имеет значение NULL, флажок не установлен.

pszExpandedInformation

Тип: PCWSTR

Указатель, который ссылается на строку, используемую для отображения дополнительных сведений. Этот параметр может быть строкой, завершаемой null, или целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE . Дополнительные сведения отображаются непосредственно под содержимым или под текстом нижнего колонтитула в зависимости от того, указан ли флаг TDF_EXPAND_FOOTER_AREA. Если для элемента dwFlags указан флаг TDF_ENABLE_HYPERLINKS, то эта строка может содержать гиперссылки в виде: <A HREF="executablestring">Hyperlink Text</A>. ПРЕДУПРЕЖДЕНИЕ. Включение гиперссылок при использовании содержимого из небезопасного источника может привести к уязвимостям системы безопасности.

pszExpandedControlText

Тип: PCWSTR

Указатель, который ссылается на строку, используемую для маркировки кнопки для сворачивания расширяемых сведений. Этот параметр может быть строкой, завершаемой null, или целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE . Этот элемент игнорируется, если элемент pszExpandedInformation имеет значение NULL. Если этот элемент имеет значение NULL и указан параметр pszCollapsedControlText , то для этого элемента также будет использоваться значение pszCollapsedControlText .

pszCollapsedControlText

Тип: PCWSTR

Указатель, который ссылается на строку, которая будет использоваться для маркировки кнопки для расширения расширяемой информации. Этот параметр может быть строкой, завершаемой null, или целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE . Этот элемент игнорируется, если элемент pszExpandedInformation имеет значение NULL. Если этот элемент имеет значение NULL и указан параметр pszCollapsedControlText , то для этого элемента также будет использоваться значение pszCollapsedControlText .

DUMMYUNIONNAME2

DUMMYUNIONNAME2.hFooterIcon

Тип: HICON

Дескриптор значка, который должен отображаться в нижнем колонтитуле диалогового окна задачи. Этот элемент игнорируется, если не указан флаг TDF_USE_HICON_FOOTER, а pszFooterIcon — нет. Если этот элемент имеет значение NULL и указан TDF_USE_HICON_FOOTER, значок не отображается.

DUMMYUNIONNAME2.pszFooterIcon

Тип: PCWSTR

Указатель, который ссылается на значок, отображаемый в области нижнего колонтитула диалогового окна задачи. Этот параметр игнорируется, если указан флаг TDF_USE_HICON_FOOTER или если pszFooter имеет значение NULL. В противном случае, если этот параметр имеет значение NULL или параметр hInstance имеет значение NULL, значок не отображается. Этот параметр должен быть целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE , или одним из предопределенных значений, перечисленных для pszMainIcon.

pszFooter

Тип: PCWSTR

Указатель на строку, используемую в области нижнего колонтитула диалогового окна задачи. Этот параметр может быть строкой, завершаемой null, или целочисленным идентификатором ресурса, передаваемым макросу MAKEINTRESOURCE . Если для элемента dwFlags указан флаг TDF_ENABLE_HYPERLINKS, эта строка может содержать гиперссылки в этой форме.

<A HREF="executablestring">Hyperlink Text</A>

Предупреждение Включение гиперссылок при использовании содержимого из небезопасного источника может привести к уязвимостям системы безопасности.

pfCallback

Тип: PFTASKDIALOGCALLBACK

Указатель на определяемую приложением функцию обратного вызова. Дополнительные сведения см. в разделе TaskDialogCallbackProc.

lpCallbackData

Тип: LONG_PTR

Указатель на определяемые приложением эталонные данные. Это значение определяется вызывающим.

cxWidth

Тип: UINT

Ширина клиентской области диалогового окна задачи в диалоговых блоках. Если значение равно 0, диспетчер диалогов задач вычислит идеальную ширину.

Требования


Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Верхняя часть	commctrl.h

Поделиться через

Структура TASKDIALOGCONFIG (commctrl.h)

Синтаксис

Члены

Требования

Обратная связь

Дополнительные ресурсы