MsgBox

Exibe uma mensagem numa caixa de diálogo, aguarda que o utilizador clique num botão e devolve um valor que indica em que botão o utilizador clicou.

Estrutura

MsgBox(mensagem[, botões][, título][, ficheiro de ajuda, contexto])

Parâmetros

mensagem - Expressão de cadeia de caracteres apresentada como mensagem na caixa de diálogo. O comprimento máximo do prompt é de aproximadamente 1024 caracteres, dependendo da largura dos caracteres utilizados. Se o prompt tiver mais do que uma linha, pode separar as linhas utilizando um carácter de retorno de carro (Chr(13)), um carácter de avanço de linha (Chr(10)) ou uma combinação de caracteres de retorno de carro e avanço de linha (Chr(13) & Chr(10)) entre cada linha.

botões - Expressão numérica que representa a soma dos valores que especificam o número e o tipo de botões a apresentar, o estilo do ícone a utilizar, a identificação do botão predefinido e a modalidade da caixa de mensagem. Consulte a secção «Definições» para ver os valores. Se não for especificado, o valor predefinido para os botões é 0.

título - Expressão de cadeia de caracteres exibida na barra de título da caixa de diálogo. Se não indicar um título, o nome da aplicação será colocado na barra de título.

helpfile - Expressão de cadeia de caracteres que identifica o ficheiro de Ajuda a utilizar para fornecer Ajuda contextual à caixa de diálogo. Se for fornecido um ficheiro de ajuda, também deve ser fornecido o contexto. Não disponível em plataformas de 16 bits.

contexto - Expressão numérica que identifica o número de contexto da Ajuda atribuído pelo autor da Ajuda ao tópico de Ajuda correspondente. Se for fornecido o contexto, também deve ser fornecido o ficheiro de ajuda. Não disponível em plataformas de 16 bits.

Valores dos parâmetros

As configurações do argumento «buttons» são:

Valor constante Descrição

vbOKOnly 0 Mostrar apenas o botão OK.

vbOKCancel 1 Exibir os botões OK e Cancelar.

vbAbortRetryIgnore 2 Exibir os botões «Abortar», «Repetir» e «Ignorar».

vbYesNoCancel 3 Exibir os botões Sim, Não e Cancelar.

vbYesNo 4 Exibir os botões Sim e Não.

vbRetryCancel 5 Exibir os botões «Reintentar» e «Cancelar».

vbCritical 16 Exibir o ícone de mensagem crítica.

vbQuestion 32 Exibir o ícone de consulta de aviso.

vbExclamation 48 Ícone para exibir mensagem de aviso.

vbInformation 64 Ícone de mensagem de exibição de informações.

vbDefaultButton1 0 O primeiro botão é o padrão.

vbDefaultButton2 256 O segundo botão é o padrão.

vbDefaultButton3 512 O terceiro botão é o padrão.

vbDefaultButton4 768 O quarto botão é o botão padrão.

vbApplicationModal 0 Modal da aplicação; o utilizador deve responder à caixa de mensagem antes de continuar a trabalhar na aplicação atual.

vbSystemModal 4096 Modal do sistema; todas as aplicações ficam suspensas até que o utilizador responda à caixa de mensagem.

O primeiro grupo de valores (0–5) descreve o número e o tipo de botões apresentados na caixa de diálogo; o segundo grupo (16, 32, 48, 64) descreve o estilo do ícone; o terceiro grupo (0, 256, 512, 768) determina qual o botão predefinido; e o quarto grupo (0, 4096) determina a modalidade da caixa de mensagem. Ao somar os números para criar um valor final para os botões de argumentos, utilize apenas um número de cada grupo.

Valor de retorno

A função MsgBox tem os seguintes valores de retorno:

Botão de valor constante

, vbOK 1 OK

vbCancel 2 Cancelar

vbAbort 3 Abortar

vbRetry 4 Tentativa

vbIgnore 5 Ignorar

vbSim 6 Sim

vbN.º 7 N.º

Descrição

Quando tanto o ficheiro de ajuda como o contexto são fornecidos, o utilizador pode premir a tecla F1 para visualizar o tópico da Ajuda correspondente ao contexto.

Se a caixa de diálogo apresentar um botão «Cancelar», premir a tecla ESC tem o mesmo efeito que clicar em «Cancelar». Se a caixa de diálogo contiver um botão de Ajuda, é disponibilizada uma Ajuda contextual para essa caixa de diálogo. No entanto, não é devolvido qualquer valor até que se clique num dos outros botões.

Quando a função MsgBox é utilizada com o Microsoft Internet Explorer, o título de qualquer caixa de diálogo apresentada contém sempre «VBScript:» para a diferenciar das caixas de diálogo padrão do sistema.

Exemplo

O exemplo seguinte utiliza a função MsgBox para apresentar uma caixa de mensagem e devolver um valor que indica qual o botão em que se clicou:

Dim MyVar

; MyVar = MsgBox("Hello World!", 65, "Exemplo de MsgBox"); ' MyVar contém 1 ou 2, dependendo do botão em que se clicar. |