MsgBox, fonction (Visual Basic)

Mise à jour : novembre 2007

Affiche un message dans une boîte de dialogue, attend que l'utilisateur clique sur un bouton, puis retourne un nombre entier qui indique le bouton choisi par l'utilisateur.

Public Function MsgBox( _
   ByVal Prompt As Object, _
   Optional ByVal Buttons As MsgBoxStyle = MsgBoxStyle.OKOnly, _
   Optional ByVal Title As Object = Nothing _
) As MsgBoxResult

Paramètres

• Prompt
  Requis. Expression String affichée comme message de la boîte de dialogue. La longueur maximale de l'argument Prompt est d'environ 1 024 caractères selon la largeur des caractères utilisés. Si Prompt se compose de plusieurs lignes, vous pouvez séparer les lignes à l'aide d'un retour chariot (13 Chr()), d'un saut de ligne (10 Chr()) ou d'une combinaison des deux caractères (13 Chr()& 10 Chr()).

• Buttons
  Facultatif. Expression numérique qui représente la somme des valeurs spécifiant le nombre et le type de boutons à afficher, le style d'icône à utiliser, l'identité du bouton par défaut, ainsi que la modalité du message. Si l'argument Buttons est omis, la valeur par défaut est zéro.

• Title
  Facultatif. Expression String affichée dans la barre de titre de la boîte de dialogue. Si l'argument Title est omis, le nom de l'application est placé dans la barre de titre.

Paramètres

Les valeurs d'énumération MsgBoxStyle sont répertoriées dans le tableau suivant.

Membre	Valeur	Description
OKOnly	0	Affiche le bouton OK uniquement.
OKCancel	1	Affiche les boutons OK et Annuler.
AbortRetryIgnore	2	Affiche les boutons Abandonner, Réessayer et Ignorer.
YesNoCancel	3	Affiche les boutons Oui, Non et Annuler.
YesNo	4	Affiche les boutons Oui et Non.
RetryCancel	5	Affiche les boutons Réessayer et Annuler.
Critical	16	Affiche l'icône Message critique.
Question	32	Affiche l'icône Requête d'avertissement.
Exclamation	48	Affiche l'icône Message d'avertissement.
Information	64	Affiche l'icône Message d'information.
DefaultButton1	0	Le premier bouton est le bouton par défaut.
DefaultButton2	256	Le deuxième bouton est le bouton par défaut.
DefaultButton3	512	Le troisième bouton est le bouton par défaut.
ApplicationModal	0	L'application est modale. L'utilisateur doit répondre au message avant de poursuivre le travail dans l'application en cours.
SystemModal	4096	Le système est modal. Toutes les applications sont interrompues jusqu'à ce que l'utilisateur réponde au message.
MsgBoxSetForeground	65536	Spécifie la fenêtre de message comme fenêtre de premier plan.
MsgBoxRight	524288	Le texte est aligné à droite.
MsgBoxRtlReading	1048576	Spécifie que le texte doit apparaître de droite à gauche sur les systèmes hébraïques et arabes.

Le premier groupe de valeurs (0-5) décrit le nombre et le type des boutons affichés dans la boîte de dialogue. Le second groupe (16, 32, 48, 64) décrit le style de l'icône. Le troisième groupe (0, 256, 512) détermine quel bouton est la valeur par défaut. Le quatrième groupe (0, 4096) détermine la modalité du message, et le cinquième groupe indique si la fenêtre de message est la fenêtre de premier plan, avec l'alignement et l'orientation du texte. Au moment d'additionner ces nombres pour obtenir la valeur finale de l'argument Buttons, ne sélectionnez qu'un seul nombre dans chaque groupe.

Valeur de retour

Constante	Valeur
OK	1
Cancel	2
Abort	3
Retry	4
Ignore	5
Yes	6
No	7

Exceptions

Type d'exception	Numéro de l'erreur	Condition
ArgumentException	5	Prompt n'est pas une expression String ou Title n'est pas valide.
InvalidOperationException	5	Le processus ne s'exécute pas en mode utilisateur interactif.
InvalidEnumArgumentException	5	Au moins un paramètre n'est pas un membre de l'énumération MsgBoxResult ou MsgBoxStyle.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion des erreurs non structurée. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreur par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Si la boîte de dialogue est dotée d'un bouton Annuler, appuyer sur Échap équivaut à cliquer sur Annuler. Si la boîte de dialogue contient un bouton Aide, cela signifie qu'une aide contextuelle relative à la boîte de dialogue est disponible. Toutefois, aucune valeur n'est retournée tant que l'utilisateur n'a pas cliqué sur l'un des autres boutons.

Remarque :
Si vous souhaitez préciser plus d'informations que celles fournies par le premier argument, vous devez utiliser la fonction MsgBox dans une expression. Si vous omettez certains arguments de position, vous devez quand même conserver la virgule de séparation correspondante.

Remarque :
La fonction MsgBox nécessite UIPermission au niveau SafeTopLevelWindows, ce qui peut affecter son exécution dans les situations où le niveau de confiance n'est pas total. Pour plus d'informations, consultez Demande d'autorisations et UIPermission.

Exemple

Cet exemple utilise la fonction MsgBox pour afficher un message d'erreur grave dans une boîte de dialogue pourvue des boutons Yes et No. Le bouton No est spécifié comme réponse par défaut. Ce résultat est obtenu en combinant les valeurs des constantes MsgBox dans une expression numérique. Dans ce cas, l'addition de 4 (la combinaison des boutons Oui/Non) avec 16 (la fenêtre Message critique) et 256 (le deuxième bouton comme bouton par défaut) donne un total de 276. La valeur retournée par la fonction MsgBox dépend du bouton choisi par l'utilisateur : Oui retourne une valeur égale à 6 ; Non retourne une valeur égale à 7.

Dim msg As String
Dim title As String
Dim style As MsgBoxStyle
Dim response As MsgBoxResult
msg = "Do you want to continue?"   ' Define message.
style = MsgBoxStyle.DefaultButton2 Or _
   MsgBoxStyle.Critical Or MsgBoxStyle.YesNo
title = "MsgBox Demonstration"   ' Define title.
' Display message.
response = MsgBox(msg, style, title)
If response = MsgBoxResult.Yes Then   ' User chose Yes.
   ' Perform some action.
Else
   ' Perform some other action.
End If

Configuration requise

Espace de noms :Microsoft.VisualBasic

**Module :**Interaction

**Assembly :**bibliothèque Visual Basic Runtime (dans Microsoft.VisualBasic.dll)

Voir aussi

Référence

InputBox, fonction (Visual Basic)