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

Definição

Namespace:
Microsoft.VisualBasic
Assembly:
Microsoft.VisualBasic.dll

Exibe uma mensagem em uma caixa de diálogo, aguarda o usuário clicar em um botão e retorna um inteiro indicando qual botão o usuário clicou.

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.ApplicationModal, Optional Title As Object = Nothing) As MsgBoxResult

Parâmetros

Prompt
Object

Required. String expressão exibida como a mensagem na caixa de diálogo. O comprimento máximo é de Prompt aproximadamente 1024 caracteres, dependendo da largura dos caracteres usados. Se Prompt consistir em mais de uma linha, você poderá separar as linhas usando um caractere de retorno de carro (Chr(13)), um caractere de feed de linha (Chr(10)) ou uma combinação de caracteres de retorno de carro/alimentação de linha (Chr(13) & Chr(10)) entre cada linha.

Buttons
MsgBoxStyle

Optional. Expressão numérica que é a soma dos valores que especificam o número e o tipo de botões a serem exibidos, o estilo de ícone a ser usado, a identidade do botão padrão e a modalidade da caixa de mensagem. Se você omitir Buttons, o valor padrão será zero.

Title
Object

Optional. String expressão exibida na barra de título da caixa de diálogo. Se você omitir Title, o nome do aplicativo será colocado na barra de título.

Retornos

MsgBoxResult

Um dos seguintes valores:

ConstanteValue
OK1
Cancel2
Abort3
Retry4
Ignore5
Yes6
No7

Exceções

ArgumentException

Prompt não é uma String expressão ou Title é inválido.

InvalidOperationException

O processo não está em execução no modo Interativo do Usuário.

InvalidEnumArgumentException

Um ou mais parâmetros que não são membros MsgBoxResult ou MsgBoxStyle enumeração.

Exemplos

Este exemplo usa a MsgBox função para exibir uma mensagem de erro crítico em uma caixa de diálogo com botões Sim e Não. O botão Não é especificado como a resposta predefinida. Isso é feito combinando os MsgBox valores constantes em uma expressão numérica. Nesse caso, adicionar 4 (a combinação de botões Sim/Não) e 16 (a janela Mensagem Crítica ) e 256 (o segundo botão como botão padrão) dá um total de 276. O valor retornado pela MsgBox função depende do botão escolhido pelo usuário: Sim, retorna um valor de 6; Não retorna um 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

Comentários

Se você omitir argumentos posicionais, deverá manter o delimitador de vírgula correspondente.

Se a caixa de diálogo exibir um botão Cancelar , pressionar a tecla ESC terá o mesmo efeito que clicar em Cancelar

Se a caixa de diálogo contiver um botão Ajuda , a Ajuda sensível ao contexto é fornecida para a caixa de diálogo. No entanto, nenhum valor é retornado até que um dos outros botões seja escolhido. Em aplicativos Windows Form, escolher o botão Help executa o evento HelpRequested para o formulário.

Observação

A MsgBox função requer UIPermission no nível, o SafeTopLevelWindows que pode afetar sua execução em situações de confiança parcial. Para obter mais informações, consulte UIPermission.

Os MsgBoxStyle valores de enumeração são listados na tabela a seguir.

Membro Value Description
Membro Value Description
OKOnly 0 Exibe somente o botão OK.
OKCancel 1 Exibe os botões OK e Cancel.
AbortRetryIgnore 2 Exibe os botões Anular, Repetir e Ignorar.
YesNoCancel 3 Exibe os botões Sim, Não e Cancelar.
YesNo 4 Exibe botões Sim e Não.
RetryCancel 5 Exibe os botões Repetir e Cancelar.
Critical 16 Exibe o ícone Mensagem Crítica.
Question 32 Exibe o ícone Consulta de Aviso.
Exclamation 48 Exibe o ícone Mensagem de Aviso.
Information 64 Exibe o ícone Mensagem de Informação.
DefaultButton1 0 O primeiro botão é predefinido.
DefaultButton2 256 O segundo botão é predefinido.
DefaultButton3 512 O terceiro botão é predefinido.
ApplicationModal 0 O aplicativo é modal. O usuário deve responder à caixa de mensagem antes de continuar o trabalho no aplicativo atual.
SystemModal 4096 O sistema é modal. Todos os aplicativos são suspensos até que o usuário responda à caixa de mensagem.
MsgBoxSetForeground 65536 Especifica a janela de caixa de mensagem como janela em primeiro plano.
MsgBoxRight 524288 O texto é alinhado à direita.
MsgBoxRtlReading 1048576 Especifica que o texto deve ser lido da direita para a esquerda nos sistemas árabe e hebraico.

O primeiro grupo de valores (0-5) descreve o número e o tipo de botões exibidos na caixa de diálogo. O segundo grupo (16, 32, 48, 64) descreve o estilo do ícone. O terceiro grupo (0, 256, 512) determina qual botão é o padrão. O quarto grupo (0, 4096) determina a modalidade da caixa de mensagem e o quinto grupo especifica se a janela da caixa de mensagem é ou não a janela de primeiro plano, juntamente com o alinhamento e a direção do texto. Ao adicionar números para criar um valor final para o Buttons argumento, use apenas um número de cada grupo.

Aplica-se a

Confira também