Interaction.MsgBox(Object, MsgBoxStyle, Object) Méthode

Définition

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 static Microsoft.VisualBasic.MsgBoxResult MsgBox (object Prompt, Microsoft.VisualBasic.MsgBoxStyle Buttons = Microsoft.VisualBasic.MsgBoxStyle.OkOnly, object? Title = default);
public static Microsoft.VisualBasic.MsgBoxResult MsgBox (object Prompt, Microsoft.VisualBasic.MsgBoxStyle Buttons = Microsoft.VisualBasic.MsgBoxStyle.ApplicationModal, object Title = default);
static member MsgBox : obj * Microsoft.VisualBasic.MsgBoxStyle * obj -> Microsoft.VisualBasic.MsgBoxResult
Public Function MsgBox (Prompt As Object, Optional Buttons As MsgBoxStyle = Microsoft.VisualBasic.MsgBoxStyle.OkOnly, Optional Title As Object = Nothing) As MsgBoxResult
Public Function MsgBox (Prompt As Object, Optional Buttons As MsgBoxStyle = Microsoft.VisualBasic.MsgBoxStyle.ApplicationModal, Optional Title As Object = Nothing) As MsgBoxResult

Paramètres

Prompt
Object

Obligatoire. Expression String affichée comme message dans 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 caractère de retour chariot (Chr(13)), d’un caractère de flux de ligne (Chr(10)) ou d’une combinaison de caractères retour chariot/retour de ligne (Chr(13) & Chr(10)) entre chaque ligne.

Buttons
MsgBoxStyle

Optionnel. 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
Object

Optionnel. 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.

Retours

Une des valeurs suivantes :

ConstanteValeur
OK1
Cancel2
Abort3
Retry4
Ignore5
Yes6
No7

Exceptions

Prompt n'est pas une expression String ou Title n'est pas valide.

Le processus ne s'exécute pas en mode utilisateur interactif.

Au moins un paramètre n'est pas un membre de l'énumération MsgBoxResult ou MsgBoxStyle.

Exemples

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

' The following example requires that Option Infer be set to On.

' Define the message you want to see inside the message box.
Dim msg = "Do you want to continue?"

' Display a simple message box.
MsgBox(msg)

' Define a title for the message box.
Dim title = "MsgBox Demonstration"

' Add the title to the display.
MsgBox(msg, , title)

' Now define a style for the message box. In this example, the
' message box will have Yes and No buttons, the default will be
' the No button, and a Critical Message icon will be present.
Dim style = MsgBoxStyle.YesNo Or MsgBoxStyle.DefaultButton2 Or
            MsgBoxStyle.Critical

' Display the message box and save the response, Yes or No.
Dim response = MsgBox(msg, style, title)

' Take some action based on the response.
If response = MsgBoxResult.Yes Then
    MsgBox("YES, continue!!", , title)
Else
    MsgBox("NO, stop!!", , title)
End If

Remarques

Si vous omettez des arguments positionnels, vous devez conserver le délimiteur de virgules correspondant.

Si la boîte de dialogue affiche un bouton Annuler , appuyer sur la touche Échap a le même effet que cliquer sur Annuler

Si la boîte de dialogue contient un bouton Aide , l’aide contextuelle est fournie pour la boîte de dialogue. Toutefois, aucune valeur n’est retournée tant que l’un des autres boutons n’est pas choisi. Dans les applications Windows Form, le fait de choisir le bouton Aide exécute l’événement HelpRequested pour le formulaire.

Notes

La MsgBox fonction nécessite UIPermission au SafeTopLevelWindows niveau, ce qui peut affecter son exécution dans des situations de confiance partielle. Pour plus d'informations, consultez UIPermission.

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

Membre Valeur Description
Membre Valeur Description
OKOnly 0 Affiche uniquement le bouton OK.
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 De 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 la valeur par défaut.
DefaultButton2 256 Le deuxième bouton est la valeur par défaut.
DefaultButton3 512 Le troisième bouton est la valeur par défaut.
ApplicationModal 0 L’application est modale. L’utilisateur doit répondre à la boîte de message avant de continuer à travailler dans l’application actuelle.
SystemModal 4096 Le système est modal. Toutes les applications sont suspendues jusqu’à ce que l’utilisateur réponde à la boîte de message.
MsgBoxSetForeground 65536 Spécifie la fenêtre de boîte de message comme fenêtre de premier plan.
MsgBoxRight 524 288 Le texte est aligné à droite.
MsgBoxRtlReading 1 048 576 Spécifie que le texte doit apparaître sous forme de lecture de droite à gauche sur les systèmes hébreux et arabes.

Le premier groupe de valeurs (0-5) décrit le nombre et le type de boutons affichés dans la boîte de dialogue. Le deuxième groupe (16, 32, 48, 64) décrit le style d’icône. Le troisième groupe (0, 256, 512) détermine le bouton par défaut. Le quatrième groupe (0, 4096) détermine la modalité de la zone de message, et le cinquième groupe spécifie si la fenêtre de la zone de message est ou non la fenêtre de premier plan, ainsi que l’alignement et la direction du texte. Lorsque vous ajoutez des nombres pour créer une valeur finale pour l’argument Buttons , utilisez un seul nombre de chaque groupe.

S’applique à

Voir aussi