Bagikan melalui


Struktur TASKDIALOGCONFIG (commctrl.h)

Struktur TASKDIALOGCONFIG berisi informasi yang digunakan untuk menampilkan dialog tugas. Fungsi TaskDialogIndirect menggunakan struktur ini.

Sintaks

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;

Anggota

cbSize

Jenis: UINT

Menentukan ukuran struktur, dalam byte.

hwndParent

Jenis: HWND

Tangani ke jendela induk. Anggota ini bisa NULL.

hInstance

Jenis: HINSTANCE

Tangani ke modul yang berisi sumber daya ikon yang diidentifikasi oleh anggota pszMainIcon atau pszFooterIcon , dan sumber daya string yang diidentifikasi oleh pszWindowTitle, pszMainInstruction, pszContent, pszVerificationText, pszExpandedInformation, pszExpandedControlText, pszCollapsedControlText , atau anggota pszFooter .

dwFlags

Jenis: TASKDIALOG_FLAGS

Menentukan perilaku dialog tugas. Parameter ini bisa menjadi kombinasi bendera dari grup berikut:

Nilai Makna
TDF_ENABLE_HYPERLINKS
Mengaktifkan pemrosesan hyperlink untuk string yang ditentukan dalam anggota pszContent, pszExpandedInformation , dan pszFooter . Saat diaktifkan, anggota ini dapat menunjuk ke string yang berisi hyperlink dalam formulir berikut:
<A HREF="executablestring">Hyperlink Text</A>

Peringatan: Mengaktifkan hyperlink saat menggunakan konten dari sumber yang tidak aman dapat menyebabkan kerentanan keamanan.

Catatan Dialog Tugas tidak akan benar-benar menjalankan hyperlink apa pun. Eksekusi hyperlink harus ditangani dalam fungsi panggilan balik yang ditentukan oleh pfCallback. Untuk detail selengkapnya, lihat TaskDialogCallbackProc.
 
TDF_USE_HICON_MAIN
Menunjukkan bahwa dialog harus menggunakan ikon yang dirujuk oleh handel di anggota hMainIcon sebagai ikon utama dalam dialog tugas. Jika bendera ini ditentukan, anggota pszMainIcon diabaikan.
TDF_USE_HICON_FOOTER
Menunjukkan bahwa dialog harus menggunakan ikon yang dirujuk oleh handel di anggota hFooterIcon sebagai ikon footer dalam dialog tugas. Jika bendera ini ditentukan, anggota pszFooterIcon diabaikan.
TDF_ALLOW_DIALOG_CANCELLATION
Menunjukkan bahwa dialog harus dapat ditutup menggunakan Alt-F4, Escape, dan tombol tutup bilah judul meskipun tidak ada tombol batal yang ditentukan di anggota dwCommonButtons atau pButtons .
TDF_USE_COMMAND_LINKS
Menunjukkan bahwa tombol yang ditentukan dalam anggota pButtons akan ditampilkan sebagai tautan perintah (menggunakan glyph dialog tugas standar) alih-alih tombol dorong. Saat menggunakan tautan perintah, semua karakter hingga karakter baris baru pertama di anggota pszButtonText akan diperlakukan sebagai teks utama tautan perintah, dan sisanya akan diperlakukan sebagai catatan tautan perintah. Bendera ini diabaikan jika anggota cButtons adalah nol.
TDF_USE_COMMAND_LINKS_NO_ICON
Menunjukkan bahwa tombol yang ditentukan dalam anggota pButtons akan ditampilkan sebagai tautan perintah (tanpa glyph) alih-alih tombol dorong. Saat menggunakan tautan perintah, semua karakter hingga karakter baris baru pertama di anggota pszButtonText akan diperlakukan sebagai teks utama tautan perintah, dan sisanya akan diperlakukan sebagai catatan tautan perintah. Bendera ini diabaikan jika anggota cButtons adalah nol.
TDF_EXPAND_FOOTER_AREA
Menunjukkan bahwa string yang ditentukan oleh anggota pszExpandedInformation ditampilkan di bagian bawah area footer dialog alih-alih segera setelah konten dialog. Bendera ini diabaikan jika anggota pszExpandedInformation adalah NULL.
TDF_EXPANDED_BY_DEFAULT
Menunjukkan bahwa string yang ditentukan oleh anggota pszExpandedInformation ditampilkan saat dialog awalnya ditampilkan. Bendera ini diabaikan jika anggota pszExpandedInformation adalah NULL.
TDF_VERIFICATION_FLAG_CHECKED
Menunjukkan bahwa kotak centang verifikasi dalam dialog dicentang saat dialog awalnya ditampilkan. Bendera ini diabaikan jika parameter pszVerificationText adalah NULL.
TDF_SHOW_PROGRESS_BAR
Menunjukkan bahwa Bilah Kemajuan akan ditampilkan.
TDF_SHOW_MARQUEE_PROGRESS_BAR
Menunjukkan bahwa Bilah Kemajuan Marquee akan ditampilkan.
TDF_CALLBACK_TIMER
Menunjukkan bahwa panggilan balik dialog tugas akan dipanggil sekitar setiap 200 milidetik.
TDF_POSITION_RELATIVE_TO_WINDOW
Menunjukkan bahwa dialog tugas diposisikan (tengah) relatif terhadap jendela yang ditentukan oleh hwndParent. Jika bendera tidak diberikan (atau tidak ada anggota hwndParent yang ditentukan), dialog tugas diposisikan (berpusat) relatif terhadap monitor.
TDF_RTL_LAYOUT
Menunjukkan bahwa teks ditampilkan membaca dari kanan ke kiri.
TDF_NO_DEFAULT_RADIO_BUTTON
Menunjukkan bahwa tidak ada item default yang akan dipilih.
TDF_CAN_BE_MINIMIZED
Menunjukkan bahwa dialog tugas dapat diminimalkan.
TDIF_SIZE_TO_CONTENT
Bendera ini tidak digunakan lagi. Gunakan TDF_SIZE_TO_CONTENT sebagai gantinya.
TDF_SIZE_TO_CONTENT
Menunjukkan bahwa lebar dialog tugas ditentukan oleh lebar area kontennya. Bendera ini diabaikan jika cxWidth tidak diatur ke 0.

dwCommonButtons

Jenis: TASKDIALOG_COMMON_BUTTON_FLAGS

Menentukan tombol dorong yang ditampilkan dalam dialog tugas. Jika tidak ada tombol umum yang ditentukan dan tidak ada tombol kustom yang ditentukan menggunakan anggota cButtons dan pButtons , dialog tugas akan berisi tombol OK secara default. Parameter ini mungkin kombinasi bendera dari grup berikut:

Nilai Makna
TDCBF_OK_BUTTON
Dialog tugas berisi tombol dorong: OK.
TDCBF_YES_BUTTON
Dialog tugas berisi tombol dorong: Ya.
TDCBF_NO_BUTTON
Dialog tugas berisi tombol dorong: Tidak.
TDCBF_CANCEL_BUTTON
Dialog tugas berisi tombol dorong: Batal. Jika tombol ini ditentukan, dialog tugas akan merespons tindakan pembatalan umum (Alt-F4 dan Escape).
TDCBF_RETRY_BUTTON
Dialog tugas berisi tombol dorong: Coba lagi.
TDCBF_CLOSE_BUTTON
Dialog tugas berisi tombol dorong: Tutup.

pszWindowTitle

Jenis: PCWSTR

Penunjuk yang mereferensikan string yang akan digunakan untuk judul dialog tugas. Parameter ini dapat berupa string yang dihentikan null atau pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE . Jika parameter ini NULL, nama file program yang dapat dieksekusi akan digunakan.

DUMMYUNIONNAME

DUMMYUNIONNAME.hMainIcon

Jenis: HICON

Handel ke Ikon yang akan ditampilkan dalam dialog tugas. Anggota ini diabaikan kecuali bendera TDF_USE_HICON_MAIN ditentukan. Jika anggota ini NULL dan TDF_USE_HICON_MAIN ditentukan, tidak ada ikon yang akan ditampilkan.

DUMMYUNIONNAME.pszMainIcon

Jenis: PCWSTR

Penunjuk yang mereferensikan ikon yang akan ditampilkan dalam dialog tugas. Parameter ini diabaikan jika bendera USE_HICON_MAIN ditentukan. Jika tidak, jika parameter ini ADALAH NULL atau parameter hInstance adalah NULL, tidak ada ikon yang akan ditampilkan. Parameter ini harus berupa pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE atau salah satu nilai yang telah ditentukan sebelumnya berikut ini:

Nilai Makna
TD_ERROR_ICON
Ikon tanda berhenti muncul dalam dialog tugas.
TD_WARNING_ICON
Ikon tanda seru muncul dalam dialog tugas.
TD_INFORMATION_ICON
Ikon yang terdiri dari huruf kecil i dalam lingkaran muncul dalam dialog tugas.
TD_SHIELD_ICON
Ikon perisai muncul dalam dialog tugas.

pszMainInstruction

Jenis: PCWSTR

Pointer yang mereferensikan string yang akan digunakan untuk instruksi utama. Parameter ini dapat berupa string yang dihentikan null atau pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE .

pszContent

Jenis: PCWSTR

Penunjuk yang mereferensikan string yang akan digunakan untuk konten utama dialog. Parameter ini dapat berupa string yang dihentikan null atau pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE . Jika bendera ENABLE_HYPERLINKS ditentukan untuk anggota dwFlags , maka string ini mungkin berisi hyperlink dalam formulir: <HREF="executablestring">Hyperlink Text</A>. PERINGATAN: Mengaktifkan hyperlink saat menggunakan konten dari sumber yang tidak aman dapat menyebabkan kerentanan keamanan.

cButtons

Jenis: UINT

Jumlah entri dalam array pButtons yang digunakan untuk membuat tombol atau tautan perintah dalam dialog tugas. Jika anggota ini nol dan tidak ada tombol umum yang ditentukan menggunakan anggota dwCommonButtons , maka dialog tugas akan menampilkan satu tombol OK .

pButtons

Jenis: const TASKDIALOG_BUTTON*

Penunjuk ke array TASKDIALOG_BUTTON struktur yang berisi definisi tombol kustom yang akan ditampilkan dalam dialog tugas. Array ini harus berisi setidaknya jumlah entri yang ditentukan oleh anggota cButtons .

nDefaultButton

Jenis: int

Tombol default untuk dialog tugas. Ini mungkin salah satu nilai yang ditentukan dalam anggota nButtonID dari salah satu struktur TASKDIALOG_BUTTON dalam array pButtons , atau salah satu ID yang sesuai dengan tombol yang ditentukan dalam anggota dwCommonButtons :

IDCANCEL Jadikan tombol Batalkan sebagai default.
IDNO Jadikan tombol Tidak sebagai default.
IDOK Jadikan tombol OK sebagai default.
IDRETRY Jadikan tombol Coba Lagi sebagai default.
IDYES Jadikan tombol Ya sebagai default.
IDCLOSE Jadikan tombol Tutup sebagai default.
 

Jika anggota ini nol atau nilainya tidak sesuai dengan ID tombol apa pun dalam dialog, maka tombol pertama dalam dialog akan menjadi default.

cRadioButtons

Jenis: UINT

Jumlah entri dalam array pRadioButtons yang digunakan untuk membuat tombol radio dalam dialog tugas.

pRadioButtons

Jenis: const TASKDIALOG_BUTTON*

Penunjuk ke array struktur TASKDIALOG_BUTTON yang berisi definisi tombol radio yang akan ditampilkan dalam dialog tugas. Array ini harus berisi setidaknya jumlah entri yang ditentukan oleh anggota cRadioButtons . Parameter ini bisa NULL.

nDefaultRadioButton

Jenis: int

ID tombol tombol radio yang dipilih secara default. Jika nilai ini tidak sesuai dengan ID tombol, tombol pertama dalam array dipilih secara default.

pszVerificationText

Jenis: PCWSTR

Penunjuk yang mereferensikan string yang akan digunakan untuk memberi label pada kotak centang verifikasi. Parameter ini dapat berupa string yang dihentikan null atau pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE . Jika parameter ini NULL, kotak centang verifikasi tidak ditampilkan dalam dialog tugas. Jika parameter pfVerificationFlagChecked dari TaskDialogIndirect adalah NULL, kotak centang tidak diaktifkan.

pszExpandedInformation

Jenis: PCWSTR

Pointer yang mereferensikan string yang akan digunakan untuk menampilkan informasi tambahan. Parameter ini dapat berupa string yang dihentikan null atau pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE . Informasi tambahan ditampilkan tepat di bawah konten atau di bawah teks footer tergantung pada apakah bendera TDF_EXPAND_FOOTER_AREA ditentukan. Jika bendera TDF_ENABLE_HYPERLINKS ditentukan untuk anggota dwFlags , maka string ini mungkin berisi hyperlink dalam formulir: <HREF="executablestring">Teks< Hyperlink/A>. PERINGATAN: Mengaktifkan hyperlink saat menggunakan konten dari sumber yang tidak aman dapat menyebabkan kerentanan keamanan.

pszExpandedControlText

Jenis: PCWSTR

Penunjuk yang mereferensikan string yang akan digunakan untuk memberi label tombol untuk menciutkan informasi yang dapat diperluas. Parameter ini dapat berupa string yang dihentikan null atau pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE . Anggota ini diabaikan ketika anggota pszExpandedInformation adalah NULL. Jika anggota ini adalah NULL dan pszCollapsedControlText ditentukan, maka nilai pszCollapsedControlText juga akan digunakan untuk anggota ini.

pszCollapsedControlText

Jenis: PCWSTR

Penunjuk yang mereferensikan string yang akan digunakan untuk memberi label tombol untuk memperluas informasi yang dapat diperluas. Parameter ini dapat berupa string yang dihentikan null atau pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE . Anggota ini diabaikan ketika anggota pszExpandedInformation adalah NULL. Jika anggota ini adalah NULL dan pszCollapsedControlText ditentukan, maka nilai pszCollapsedControlText juga akan digunakan untuk anggota ini.

DUMMYUNIONNAME2

DUMMYUNIONNAME2.hFooterIcon

Jenis: HICON

Handel ke Ikon yang akan ditampilkan di footer dialog tugas. Anggota ini diabaikan kecuali bendera TDF_USE_HICON_FOOTER ditentukan dan pszFooterIcon tidak. Jika anggota ini NULL dan TDF_USE_HICON_FOOTER ditentukan, tidak ada ikon yang ditampilkan.

DUMMYUNIONNAME2.pszFooterIcon

Jenis: PCWSTR

Penunjuk yang mereferensikan ikon yang akan ditampilkan di area footer dialog tugas. Parameter ini diabaikan jika bendera TDF_USE_HICON_FOOTER ditentukan, atau jika pszFooter adalah NULL. Jika tidak, jika parameter ini adalah NULL atau parameter hInstance adalah NULL, tidak ada ikon yang ditampilkan. Parameter ini harus berupa pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE atau salah satu nilai yang telah ditentukan sebelumnya yang tercantum untuk pszMainIcon.

pszFooter

Jenis: PCWSTR

Penunjuk ke string yang akan digunakan di area footer dialog tugas. Parameter ini dapat berupa string yang dihentikan null atau pengidentifikasi sumber daya bilangan bulat yang diteruskan ke makro MAKEINTRESOURCE . Jika bendera TDF_ENABLE_HYPERLINKS ditentukan untuk anggota dwFlags , maka string ini mungkin berisi hyperlink dalam formulir ini.

<A HREF="executablestring">Hyperlink Text</A>
Peringatan Mengaktifkan hyperlink saat menggunakan konten dari sumber yang tidak aman dapat menyebabkan kerentanan keamanan.
 

pfCallback

Jenis: PFTASKDIALOGCALLBACK

Penunjuk ke fungsi panggilan balik yang ditentukan aplikasi. Untuk informasi selengkapnya, lihat TaskDialogCallbackProc.

lpCallbackData

Jenis: LONG_PTR

Penunjuk ke data referensi yang ditentukan aplikasi. Nilai ini ditentukan oleh pemanggil.

cxWidth

Jenis: UINT

Lebar area klien dialog tugas, dalam unit dialog. Jika 0, manajer dialog tugas akan menghitung lebar ideal.

Persyaratan

   
Klien minimum yang didukung Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung Windows Server 2008 [hanya aplikasi desktop]
Header commctrl.h