Structure TASKDIALOGCONFIG (commctrl.h)
La structure TASKDIALOGCONFIG contient des informations utilisées pour afficher une boîte de dialogue de tâche. La fonction TaskDialogIndirect utilise cette structure.
Syntaxe
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;
Membres
cbSize
Type : UINT
Spécifie la taille de la structure, en octets.
hwndParent
Type : HWND
Handle vers la fenêtre parente. Ce membre peut avoir la valeur NULL.
hInstance
Type : HINSTANCE
Gérez le module qui contient la ressource d’icône identifiée par les membres pszMainIcon ou pszFooterIcon , et les ressources de chaîne identifiées par les membres pszWindowTitle, pszMainInstruction, pszContent, pszVerificationText, pszExpandedInformation, pszExpandedControlText, pszCollapsedControlText ou pszFooter .
dwFlags
Type : TASKDIALOG_FLAGS
Spécifie le comportement de la boîte de dialogue de tâche. Ce paramètre peut être une combinaison d’indicateurs du groupe suivant :
| Valeur | Signification |
|---|---|
|
Active le traitement des liens hypertexte pour les chaînes spécifiées dans les membres pszContent, pszExpandedInformation et pszFooter . Lorsque cette option est activée, ces membres peuvent pointer vers des chaînes qui contiennent des liens hypertexte sous la forme suivante :Avertissement : L’activation des liens hypertexte lors de l’utilisation de contenu provenant d’une source non sécurisée peut entraîner des failles de sécurité. Note Les boîtes de dialogue de tâche n’exécutent pas de liens hypertexte. L’exécution du lien hypertexte doit être gérée dans la fonction de rappel spécifiée par pfCallback. Pour plus d’informations, consultez TaskDialogCallbackProc.
|
|
Indique que la boîte de dialogue doit utiliser l’icône référencée par le handle dans le membre hMainIcon comme icône principale dans la boîte de dialogue de tâche. Si cet indicateur est spécifié, le membre pszMainIcon est ignoré. |
|
Indique que la boîte de dialogue doit utiliser l’icône référencée par le handle dans le membre hFooterIcon comme icône de pied de page dans la boîte de dialogue de tâche. Si cet indicateur est spécifié, le membre pszFooterIcon est ignoré. |
|
Indique que la boîte de dialogue doit pouvoir être fermée à l’aide de alt-F4, d’échappement et du bouton fermer de la barre de titre, même si aucun bouton d’annulation n’est spécifié dans les membres dwCommonButtons ou pButtons . |
|
Indique que les boutons spécifiés dans le membre pButtons doivent être affichés sous forme de liens de commande (à l’aide d’un glyphe de boîte de dialogue de tâche standard) au lieu de boutons push. Lors de l’utilisation de liens de commande, tous les caractères jusqu’au premier caractère de nouvelle ligne dans le membre pszButtonText seront traités comme le texte main du lien de commande, et le reste sera traité comme la note du lien de commande. Cet indicateur est ignoré si le membre cButtons est égal à zéro. |
|
Indique que les boutons spécifiés dans le membre pButtons doivent être affichés sous forme de liens de commande (sans glyphe) au lieu de boutons push. Lors de l’utilisation de liens de commande, tous les caractères jusqu’au premier caractère de nouvelle ligne dans le membre pszButtonText seront traités comme le texte main du lien de commande, et le reste sera traité comme la note du lien de commande. Cet indicateur est ignoré si le membre cButtons est égal à zéro. |
|
Indique que la chaîne spécifiée par le membre pszExpandedInformation s’affiche en bas de la zone de pied de page de la boîte de dialogue plutôt qu’immédiatement après le contenu de la boîte de dialogue. Cet indicateur est ignoré si le membre pszExpandedInformation a la valeur NULL. |
|
Indique que la chaîne spécifiée par le membre pszExpandedInformation s’affiche lorsque la boîte de dialogue est initialement affichée. Cet indicateur est ignoré si le membre pszExpandedInformation a la valeur NULL. |
|
Indique que la case à cocher de vérification dans le dialogue est cochée lorsque la boîte de dialogue est initialement affichée. Cet indicateur est ignoré si le paramètre pszVerificationText a la valeur NULL. |
|
Indique qu’une barre de progression doit être affichée. |
|
Indique qu’une barre de progression de marque doit être affichée. |
|
Indique que le rappel de la boîte de dialogue de tâche doit être appelé environ toutes les 200 millisecondes. |
|
Indique que la boîte de dialogue de tâche est positionnée (centrée) par rapport à la fenêtre spécifiée par hwndParent. Si l’indicateur n’est pas fourni (ou si aucun membre hwndParent n’est spécifié), la boîte de dialogue de tâche est positionnée (centrée) par rapport au moniteur. |
|
Indique que le texte est affiché de droite à gauche. |
|
Indique qu’aucun élément par défaut n’est sélectionné. |
|
Indique que la boîte de dialogue de tâche peut être réduite. |
|
Cet indicateur est déconseillé. Utilisez TDF_SIZE_TO_CONTENT à la place. |
|
Indique que la largeur de la boîte de dialogue de tâche est déterminée par la largeur de sa zone de contenu. Cet indicateur est ignoré si cxWidth n’est pas défini sur 0. |
dwCommonButtons
Type : TASKDIALOG_COMMON_BUTTON_FLAGS
Spécifie les boutons push affichés dans la boîte de dialogue de tâche. Si aucun bouton commun n’est spécifié et qu’aucun bouton personnalisé n’est spécifié à l’aide des membres cButtons et pButtons , la boîte de dialogue de tâche contient le bouton OK par défaut. Ce paramètre peut être une combinaison d’indicateurs du groupe suivant :
pszWindowTitle
Type : PCWSTR
Pointeur qui fait référence à la chaîne à utiliser pour le titre de la boîte de dialogue de tâche. Ce paramètre peut être une chaîne terminée par null ou un identificateur de ressource entier passé à la macro MAKEINTRESOURCE . Si ce paramètre a la valeur NULL, le nom de fichier du programme exécutable est utilisé.
DUMMYUNIONNAME
DUMMYUNIONNAME.hMainIcon
Type : HICON
Handle d’une icône qui doit être affichée dans la boîte de dialogue de tâche. Ce membre est ignoré, sauf si l’indicateur TDF_USE_HICON_MAIN est spécifié. Si ce membre a la valeur NULL et que le TDF_USE_HICON_MAIN est spécifié, aucune icône ne s’affiche.
DUMMYUNIONNAME.pszMainIcon
Type : PCWSTR
Pointeur qui fait référence à l’icône à afficher dans la boîte de dialogue de tâche. Ce paramètre est ignoré si l’indicateur USE_HICON_MAIN est spécifié. Sinon, si ce paramètre a la valeur NULL ou si le paramètre hInstance a la valeur NULL, aucune icône ne s’affiche. Ce paramètre doit être un identificateur de ressource entier passé à la macro MAKEINTRESOURCE ou l’une des valeurs prédéfinies suivantes :
pszMainInstruction
Type : PCWSTR
Pointeur qui fait référence à la chaîne à utiliser pour l’instruction main. Ce paramètre peut être une chaîne terminée par une valeur Null ou un identificateur de ressource entier passé à la macro MAKEINTRESOURCE .
pszContent
Type : PCWSTR
Pointeur qui fait référence à la chaîne à utiliser pour le contenu principal de la boîte de dialogue. Ce paramètre peut être une chaîne terminée par une valeur Null ou un identificateur de ressource entier passé à la macro MAKEINTRESOURCE . Si l’indicateur ENABLE_HYPERLINKS est spécifié pour le membre dwFlags , cette chaîne peut contenir des liens hypertexte sous la forme : <A HREF="executablestring">Hyperlink Text</A>. AVERTISSEMENT : L’activation des liens hypertexte lors de l’utilisation de contenu provenant d’une source non sécurisée peut entraîner des failles de sécurité.
cButtons
Type : UINT
Nombre d’entrées dans le tableau pButtons utilisé pour créer des boutons ou des liens de commande dans la boîte de dialogue de tâche. Si ce membre est égal à zéro et qu’aucun bouton commun n’a été spécifié à l’aide du membre dwCommonButtons , un seul bouton OK s’affiche dans la boîte de dialogue de tâche.
pButtons
Type : const TASKDIALOG_BUTTON*
Pointeur vers un tableau de structures TASKDIALOG_BUTTON contenant la définition des boutons personnalisés qui doivent être affichés dans la boîte de dialogue de tâche. Ce tableau doit contenir au moins le nombre d’entrées spécifiées par le membre cButtons .
nDefaultButton
Type : int
Bouton par défaut de la boîte de dialogue de tâche. Il peut s’agir de l’une des valeurs spécifiées dans les membres nButtonID de l’une des structures TASKDIALOG_BUTTON dans le tableau pButtons , ou de l’un des ID correspondant aux boutons spécifiés dans le membre dwCommonButtons :
| IDCANCEL | Faites du bouton Annuler la valeur par défaut. |
| IDNO | Faites du bouton Non la valeur par défaut. |
| IDOK | Définissez le bouton OK comme bouton par défaut. |
| IDRETRY | Faites du bouton Réessayer la valeur par défaut. |
| IDYES | Faites du bouton Oui la valeur par défaut. |
| IDCLOSE | Faites du bouton Fermer la valeur par défaut. |
Si ce membre est égal à zéro ou si sa valeur ne correspond à aucun ID de bouton dans la boîte de dialogue, le premier bouton de la boîte de dialogue est la valeur par défaut.
cRadioButtons
Type : UINT
Nombre d’entrées dans le tableau pRadioButtons utilisé pour créer des cases d’option dans la boîte de dialogue de tâche.
pRadioButtons
Type : const TASKDIALOG_BUTTON*
Pointeur vers un tableau de structures TASKDIALOG_BUTTON contenant la définition des cases d’option qui doivent être affichées dans la boîte de dialogue de tâche. Ce tableau doit contenir au moins le nombre d’entrées spécifiées par le membre cRadioButtons . Ce paramètre peut être NULL.
nDefaultRadioButton
Type : int
ID de bouton de la case d’option sélectionnée par défaut. Si cette valeur ne correspond pas à un ID de bouton, le premier bouton du tableau est sélectionné par défaut.
pszVerificationText
Type : PCWSTR
Pointeur qui fait référence à la chaîne à utiliser pour étiqueter la case à cocher de vérification. Ce paramètre peut être une chaîne terminée par une valeur Null ou un identificateur de ressource entier passé à la macro MAKEINTRESOURCE . Si ce paramètre a la valeur NULL, la case à cocher de vérification n’est pas affichée dans la boîte de dialogue de tâche. Si le paramètre pfVerificationFlagChecked de TaskDialogIndirect a la valeur NULL, la case à cocher n’est pas activée.
pszExpandedInformation
Type : PCWSTR
Pointeur qui fait référence à la chaîne à utiliser pour afficher des informations supplémentaires. Ce paramètre peut être une chaîne terminée par une valeur Null ou un identificateur de ressource entier passé à la macro MAKEINTRESOURCE . Les informations supplémentaires s’affichent immédiatement sous le contenu ou sous le texte de pied de page, selon que l’indicateur TDF_EXPAND_FOOTER_AREA est spécifié ou non. Si l’indicateur TDF_ENABLE_HYPERLINKS est spécifié pour le membre dwFlags , cette chaîne peut contenir des liens hypertexte sous la forme : <A HREF="executablestring">Hyperlink Text</A>. AVERTISSEMENT : L’activation des liens hypertexte lors de l’utilisation de contenu provenant d’une source non sécurisée peut entraîner des failles de sécurité.
pszExpandedControlText
Type : PCWSTR
Pointeur qui fait référence à la chaîne à utiliser pour étiqueter le bouton pour réduire les informations extensibles. Ce paramètre peut être une chaîne terminée par une valeur Null ou un identificateur de ressource entier passé à la macro MAKEINTRESOURCE . Ce membre est ignoré lorsque le membre pszExpandedInformation a la valeur NULL. Si ce membre a la valeur NULL et que pszCollapsedControlText est spécifié, la valeur pszCollapsedControlText est également utilisée pour ce membre.
pszCollapsedControlText
Type : PCWSTR
Pointeur qui fait référence à la chaîne à utiliser pour étiqueter le bouton pour développer les informations extensibles. Ce paramètre peut être une chaîne terminée par une valeur Null ou un identificateur de ressource entier passé à la macro MAKEINTRESOURCE . Ce membre est ignoré lorsque le membre pszExpandedInformation a la valeur NULL. Si ce membre a la valeur NULL et que pszCollapsedControlText est spécifié, la valeur pszCollapsedControlText est également utilisée pour ce membre.
DUMMYUNIONNAME2
DUMMYUNIONNAME2.hFooterIcon
Type : HICON
Handle d’une icône qui doit être affichée dans le pied de page de la boîte de dialogue de tâche. Ce membre est ignoré, sauf si l’indicateur TDF_USE_HICON_FOOTER est spécifié et que pszFooterIcon ne l’est pas. Si ce membre a la valeur NULL et que le TDF_USE_HICON_FOOTER est spécifié, aucune icône n’est affichée.
DUMMYUNIONNAME2.pszFooterIcon
Type : PCWSTR
Pointeur qui fait référence à l’icône à afficher dans la zone de pied de page de la boîte de dialogue de tâche. Ce paramètre est ignoré si l’indicateur TDF_USE_HICON_FOOTER est spécifié ou si pszFooter a la valeur NULL. Sinon, si ce paramètre a la valeur NULL ou si le paramètre hInstance a la valeur NULL, aucune icône n’est affichée. Ce paramètre doit être un identificateur de ressource entier passé à la macro MAKEINTRESOURCE ou à l’une des valeurs prédéfinies répertoriées pour pszMainIcon.
pszFooter
Type : PCWSTR
Pointeur vers la chaîne à utiliser dans la zone de pied de page de la boîte de dialogue de tâche. Ce paramètre peut être une chaîne terminée par une valeur Null ou un identificateur de ressource entier passé à la macro MAKEINTRESOURCE . Si l’indicateur TDF_ENABLE_HYPERLINKS est spécifié pour le membre dwFlags , cette chaîne peut contenir des liens hypertexte dans ce formulaire.
<A HREF="executablestring">Hyperlink Text</A>
pfCallback
Type : PFTASKDIALOGCALLBACK
Pointeur vers une fonction de rappel définie par l’application. Pour plus d’informations, consultez TaskDialogCallbackProc.
lpCallbackData
Type : LONG_PTR
Pointeur vers des données de référence définies par l’application. Cette valeur est définie par l’appelant.
cxWidth
Type : UINT
Largeur de la zone cliente de la boîte de dialogue de tâche, en unités de dialogue. Si la valeur est 0, le gestionnaire de boîtes de dialogue de tâches calcule la largeur idéale.
Configuration requise
| Client minimal pris en charge | Windows Vista [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2008 [applications de bureau uniquement] |
| En-tête | commctrl.h |
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour