TASKDIALOGCONFIG 構造体 (commctrl.h)

  • [アーティクル]

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
 dwCommonButtons メンバーまたは pButtons メンバーでキャンセル ボタンが指定されていない場合でも、Alt キーを押しながら F4 キー、エスケープキー、タイトル バーの閉じるボタンを使用してダイアログを閉じることができるようにすることを示します。
TDF_USE_COMMAND_LINKS
 pButtons メンバーで指定されたボタンを、プッシュ ボタンの代わりにコマンド リンク (標準のタスク ダイアログ グリフを使用) として表示することを示します。 コマンド リンクを使用する場合、pszButtonText メンバーの最初の改行文字までのすべての文字がコマンド リンクのメインテキストとして扱われ、残りはコマンド リンクのメモとして扱われます。 cButtons メンバーが 0 の場合、このフラグは無視されます。
TDF_USE_COMMAND_LINKS_NO_ICON
 pButtons メンバーで指定されたボタンが、プッシュ ボタンではなくコマンド リンク (グリフなし) として表示されることを示します。 コマンド リンクを使用する場合、pszButtonText メンバーの最初の改行文字までのすべての文字がコマンド リンクのメインテキストとして扱われ、残りはコマンド リンクのメモとして扱われます。 cButtons メンバーが 0 の場合、このフラグは無視されます。
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 メンバーを使用してカスタム ボタンが指定されていない場合、タスク ダイアログには既定で [OK] ボタンが含まれます。 このパラメーターは、次のグループのフラグの組み合わせである場合があります。

値 意味
TDCBF_OK_BUTTON
 タスク ダイアログには、[ OK] というプッシュ ボタンが含まれています。
TDCBF_YES_BUTTON
 タスク ダイアログには、[ はい] というプッシュ ボタンが含まれています。
TDCBF_NO_BUTTON
 タスク ダイアログには、[ いいえ] というプッシュ ボタンが含まれています。
TDCBF_CANCEL_BUTTON
 タスク ダイアログには、[ キャンセル] というプッシュ ボタンが含まれています。 このボタンを指定すると、タスク ダイアログは一般的なキャンセル アクション (Alt + F4 キーとエスケープ) に応答します。
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 マクロに渡される整数リソース ID、または次の定義済み値のいずれかである必要があります。

値 意味
TD_ERROR_ICON
 タスク ダイアログに停止記号アイコンが表示されます。
TD_WARNING_ICON
 感嘆符アイコンがタスク ダイアログに表示されます。
TD_INFORMATION_ICON
 タスク ダイアログに、円の中の小文字 i で構成されるアイコンが表示されます。
TD_SHIELD_ICON
 タスク ダイアログにシールド アイコンが表示されます。

pszMainInstruction

種類: PCWSTR

メイン命令に使用する文字列を参照するポインター。 このパラメーターには、NULL で終わる文字列、または MAKEINTRESOURCE マクロに渡される整数リソース識別子を指定できます。

pszContent

種類: PCWSTR

ダイアログのプライマリ コンテンツに使用される文字列を参照するポインター。 このパラメーターには、NULL で終わる文字列、または MAKEINTRESOURCE マクロに渡される整数リソース識別子を指定できます。 dwFlags メンバーに対して ENABLE_HYPERLINKS フラグが指定されている場合、この文字列には、A HREF="executablestring">Hyperlink Text</A> という形式<のハイパーリンクが含まれている可能性があります。 警告: 安全でないソースのコンテンツを使用するときにハイパーリンクを有効にすると、セキュリティの脆弱性が発生する可能性があります。

cButtons

型: UINT

タスク ダイアログでボタンまたはコマンド リンクを作成するために使用される pButtons 配列内のエントリの数。 このメンバーが 0 で、 dwCommonButtons メンバーを使用して共通ボタンが指定されていない場合、タスク ダイアログには 1 つの [OK] ボタンが表示されます。

pButtons

型: const TASKDIALOG_BUTTON*

タスク ダイアログに表示されるカスタム ボタンの定義 を含むTASKDIALOG_BUTTON構造体の配列へのポインター。 この配列には、 少なくとも cButtons メンバーによって指定されたエントリの数が含まれている必要があります。

nDefaultButton

型: int

タスク ダイアログの既定のボタン。 これは、pButtons 配列のTASKDIALOG_BUTTON構造体の nButtonID メンバーで指定された値、または dwCommonButtons メンバーで指定されたボタンに対応する ID のいずれかです。

IDCANCEL [キャンセル] ボタンを既定にします。
IDNO [いいえ] ボタンを既定値にします。
IDOK [OK] ボタンを既定にします。
IDRETRY [再試行] ボタンを既定にします。
IDYES [はい] ボタンを既定にします。
IDCLOSE [閉じる] ボタンを既定にします。
 

このメンバーが 0 であるか、その値がダイアログ内のボタン ID に対応しない場合、ダイアログ内の最初のボタンが既定値になります。

cRadioButtons

型: UINT

タスク ダイアログでラジオ ボタンを作成するために使用される pRadioButtons 配列内のエントリの数。

pRadioButtons

型: const TASKDIALOG_BUTTON*

タスク ダイアログに表示されるラジオ ボタンの定義 を含むTASKDIALOG_BUTTON構造体の配列へのポインター。 この配列には、 cRadioButtons メンバーによって指定されたエントリの数以上が含まれている必要があります。 このパラメーターは、NULL でもかまいません。

nDefaultRadioButton

型: int

既定で選択されているラジオ ボタンのボタン ID。 この値がボタン ID に対応していない場合、配列内の最初のボタンが既定で選択されます。

pszVerificationText

種類: PCWSTR

検証チェックボックスのラベル付けに使用する文字列を参照するポインター。 このパラメーターには、NULL で終わる文字列、または MAKEINTRESOURCE マクロに渡される整数リソース識別子を指定できます。 このパラメーターが NULL の場合、検証チェック ボックスはタスク ダイアログに表示されません。 TaskDialogIndirect の pfVerificationFlagChecked パラメーターが NULL の場合、このチェック ボックスは有効になっていません。

pszExpandedInformation

種類: PCWSTR

追加情報の表示に使用する文字列を参照するポインター。 このパラメーターには、NULL で終わる文字列、または MAKEINTRESOURCE マクロに渡される整数リソース識別子を指定できます。 追加情報は、TDF_EXPAND_FOOTER_AREA フラグが指定されているかどうかに応じて、コンテンツのすぐ下またはフッター テキストの下に表示されます。 dwFlags メンバーに対して TDF_ENABLE_HYPERLINKS フラグが指定されている場合、この文字列には、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 [デスクトップ アプリのみ]
Header commctrl.h