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

Definición

Espacio de nombres:

Microsoft.VisualBasic

Ensamblado:

Microsoft.VisualBasic.Core.dll

Source:

Interaction.vb

Muestra un mensaje en un cuadro de diálogo, espera a que el usuario haga clic en un botón y, a continuación, devuelve un entero que indica el botón en el que el usuario ha hecho clic.

public static Microsoft.VisualBasic.MsgBoxResult MsgBox (object Prompt, Microsoft.VisualBasic.MsgBoxStyle Buttons = Microsoft.VisualBasic.MsgBoxStyle.OkOnly, 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

Parámetros

Prompt

Object

Obligatorio. Expresión de tipo String que se muestra como mensaje en el cuadro de diálogo. La longitud máxima de Prompt es aproximadamente de 1024 caracteres, dependiendo del ancho de los caracteres utilizados. Si Prompt consta de más de una línea, puede separar las líneas mediante un carácter de retorno de carro (Chr(13)), un carácter de avance de línea (Chr(10)) o una combinación de caracteres de retorno de carro/avance de línea (Chr(13) & Chr(10)) entre cada línea.

Buttons

MsgBoxStyle

Opcional. Expresión numérica que es la suma de los valores que especifican el número y el tipo de botones que se van a mostrar, el estilo de icono que se va a utilizar, la identidad del botón predeterminado y la modalidad del cuadro de mensaje. Si se omite Buttons, el valor predeterminado es cero.

Title

Object

Opcional. Expresión de tipo String que se muestra en la barra de título del cuadro de diálogo. Si se omite Title, aparece el nombre de la aplicación en la barra de título.

Devoluciones

MsgBoxResult

Uno de los siguientes valores:

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

Excepciones

ArgumentException

Prompt no es una expresión String o Title no es válido.

InvalidOperationException

El proceso no se está ejecutando en modo interactivo de usuario.

InvalidEnumArgumentException

Uno o más parámetros no son miembros de la enumeración MsgBoxResult o MsgBoxStyle.

Ejemplos

En este ejemplo se usa la MsgBox función para mostrar un mensaje de error crítico en un cuadro de diálogo con botones Sí y No. El botón No se especifica como la respuesta predeterminada. Para ello, se combinan los MsgBox valores constantes en una expresión numérica. En este caso, agregar 4 (la combinación de botones Sí/No) y 16 (la ventana Mensaje crítico ) y 256 (el segundo botón como botón predeterminado) proporciona un total de 276. El valor devuelto por la MsgBox función depende del botón elegido por el usuario: Sí devuelve un valor de 6; No devuelve un valor de 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

Comentarios

Si omite cualquier argumento posicional, debe conservar el delimitador de comas correspondiente.

Si el cuadro de diálogo muestra un botón Cancelar, presionar la tecla ESC tiene el mismo efecto que hacer clic en Cancelar.

Si el cuadro de diálogo contiene un botón Ayuda , se proporciona ayuda contextual para el cuadro de diálogo. Sin embargo, no se devuelve ningún valor hasta que se elige uno de los otros botones. En las aplicaciones de Windows Forms, al elegir el botón Ayuda se ejecuta el HelpRequested evento del formulario.

Nota

La MsgBox función requiere UIPermission en el SafeTopLevelWindows nivel , que puede afectar a su ejecución en situaciones de confianza parcial. Para obtener más información, vea UIPermission.

Los MsgBoxStyle valores de enumeración se enumeran en la tabla siguiente.

Miembro	Valor	Descripción
Miembro	Valor	Descripción
OKOnly	0	Muestra solo el botón Aceptar.
OKCancel	1	Muestra los botones Aceptar y Cancelar.
AbortRetryIgnore	2	Muestra los botones Anular, Reintentar e Omitir.
YesNoCancel	3	Muestra los botones Sí, No y Cancelar.
YesNo	4	Muestra los botones Sí y No.
RetryCancel	5	Muestra los botones Reintentar y Cancelar.
Critical	16	Muestra el icono De mensaje crítico.
Question	32	Muestra el icono consulta de advertencia.
Exclamation	48	Muestra el icono mensaje de advertencia.
Information	64	Muestra el icono de mensaje de información.
DefaultButton1	0	El primer botón es el predeterminado.
DefaultButton2	256	El segundo botón es el predeterminado.
DefaultButton3	512	El tercer botón es el predeterminado.
ApplicationModal	0	La aplicación es modal. El usuario debe responder al cuadro de mensaje antes de continuar trabajando en la aplicación actual.
SystemModal	4096	El sistema es modal. Se suspenden todas las aplicaciones hasta que el usuario responda al cuadro de mensaje.
MsgBoxSetForeground	65536	Especifica la ventana del cuadro de mensaje como la ventana de primer plano.
MsgBoxRight	524 288	El texto está alineado a la derecha.
MsgBoxRtlReading	1 048 576	Especifica que el texto debe aparecer como lectura de derecha a izquierda en los sistemas hebreo y árabe.

El primer grupo de valores (0-5) describe el número y el tipo de botones que se muestran en el cuadro de diálogo. El segundo grupo (16, 32, 48, 64) describe el estilo de icono. El tercer grupo (0, 256, 512) determina qué botón es el valor predeterminado. El cuarto grupo (0, 4096) determina la modalidad del cuadro de mensaje y el quinto grupo especifica si la ventana del cuadro de mensaje es la ventana de primer plano, junto con la alineación y la dirección del texto. Al agregar números para crear un valor final para el Buttons argumento, use solo un número de cada grupo.

Consulte también

• InputBox(String, String, String, Int32, Int32)
• Show(String)