Numa base de dados de ambiente de trabalho Access, a Função MsgBox apresenta uma mensagem numa caixa de diálogo, aguarda que o utilizador clique num botão e devolve um Número Inteiro que indica o botão em que o utilizador clicou.
Sintaxe
MsgBox ( prompt [, botões ] [, título ] [, ficheiro de ajuda ] [, contexto ] )
A sintaxe da função MsgBox tem estes argumentos:
Argumento |
Descrição |
---|---|
pedido |
Obrigatório. Expressão de cadeia apresentada como a mensagem na caixa de diálogo. O comprimento máximo do pedido é de aproximadamente 1024 carateres, consoante a largura dos carateres utilizados. Se o pedido for composto por mais do que uma linha, pode separar as linhas utilizando um caráter de retorno de símbolo (Chr(13)), um caráter de linefeed (Chr(10)) ou retorno de símbolo – combinação de carateres de avanço de linha (Chr(13) & Chr(10)) entre cada linha. |
botões |
Opcional. expressão numérica que é a soma dos valores que especificam o número e o tipo de botões a apresentar, o estilo de ícone a utilizar, a identidade do botão predefinido e a modalidade da caixa de mensagem. Se omitido, o valor predefinido para botões é 0. |
title |
Opcional. Expressão de cadeia apresentada na barra de título da caixa de diálogo. Se omitir o título, o nome da aplicação é colocado na barra de título. |
ficheiro de ajuda |
Opcional. Expressão de cadeia que identifica o ficheiro de Ajuda a utilizar para fornecer Ajuda sensível ao contexto para a caixa de diálogo. Se for fornecido helpfile , o contexto também tem de ser fornecido. |
contexto |
Opcional. Expressão numérica que é o número de contexto da Ajuda atribuído ao tópico de Ajuda adequado pelo autor da Ajuda. Se o contexto for fornecido, o helpfile também tem de ser fornecido. |
Configurações
Os botõesargumento definições são:
Constante |
Valor |
Descrição |
---|---|---|
vbOKOnly |
0 |
Apresentar apenas o botão OK . |
vbOKCancel |
1 |
Apresentar os botões OK e Cancelar . |
vbAbortRetryIgnore |
2 |
Apresentar os botões Abortar, Repetir e Ignorar . |
vbYesNoCancel |
3 |
Apresentar os botões Sim, Não e Cancelar . |
vbYesNo |
4 |
Apresentar os botões Sim e Não . |
vbRetryCancel |
5 |
Apresentar os botões Repetir e Cancelar . |
vbCritical |
16 |
Ícone Apresentar Mensagem Crítica . |
vbQuestion |
32 |
Ícone Apresentar Consulta de Aviso . |
vbExclamation |
48 |
Ícone Apresentar Mensagem de Aviso . |
vbInformation |
64 |
Ícone Apresentar Mensagem de Informação . |
vbDefaultButton1 |
0 |
O primeiro botão é predefinido. |
vbDefaultButton2 |
256 |
O segundo botão é predefinido. |
vbDefaultButton3 |
512 |
O terceiro botão é predefinido. |
vbDefaultButton4 |
768 |
O quarto botão é predefinido. |
vbApplicationModal |
0 |
Modal da aplicação; o utilizador tem de responder à caixa de mensagem antes de continuar a trabalhar na aplicação atual. |
vbSystemModal |
4096 |
Modal do sistema; todas as aplicações são suspensas até que o utilizador responda à caixa de mensagem. |
vbMsgBoxHelpButton |
16384 |
Adiciona o botão Ajuda à caixa de mensagem |
VbMsgBoxSetForeground |
65536 |
Especifica a janela da caixa de mensagem como a janela de primeiro plano |
vbMsgBoxRight |
524288 |
O texto está alinhado à direita |
vbMsgBoxRtlReading |
1048576 |
Especifica que o texto deve aparecer como leitura da direita para a esquerda nos sistemas hebraico e árabe |
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) determina qual é o botão predefinido; e o quarto grupo (0, 4096) determina a modalidade da caixa de mensagem. Ao adicionar números para criar um valor final para o argumento botões , utilize apenas um número de cada grupo.
Observação: Estas constantes são especificadas pelo Visual Basic for Applications. Como resultado, os nomes podem ser utilizados em qualquer parte do seu código em vez dos valores reais.
Valores devolvidos
Constante |
Valor |
Descrição |
---|---|---|
vbOK |
1 |
OK |
vbCancel |
2 |
Cancelar |
vbAbort |
3 |
Abortar |
vbRetry |
4 |
Repetição |
vbIgnore |
5 |
Ignorar |
vbYes |
6 |
Sim |
vbNo |
7 |
Não |
Comentários
Quando o ficheiro de ajuda e o contexto são fornecidos, o utilizador pode premir F1 (Windows) ou HELP (macOS) para ver o tópico de Ajuda correspondente ao contexto. Algumas aplicações anfitriãs, por exemplo, o Microsoft Excel, também adicionam automaticamente um botão Ajuda à caixa de diálogo.
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 Ajuda , a Ajuda sensível ao contexto é fornecida para a caixa de diálogo. No entanto, nenhum valor é devolvido até que um dos outros botões seja clicado.
Observação: Para especificar mais do que o primeiro argumento nomeado, tem de utilizar o MsgBox num expressão. Para omitir alguns argumentos posicionais, tem de incluir o delimitador de vírgulas correspondente.
Exemplo
Observação: Os exemplos que se seguem demonstram a utilização desta função num módulo VBA (Visual Basic for Applications).
Este exemplo utiliza a função MsgBox para apresentar uma mensagem de erro crítico numa caixa de diálogo com os botões Sim e Não. O botão Não é especificado como a resposta predefinida. O valor devolvido pela função MsgBox depende do botão escolhido pelo utilizador. Este exemplo pressupõe que DEMO.HLP é um ficheiro de Ajuda que contém um tópico com um número de contexto de Ajuda igual a 1000.
Dim Msg, Style, Title, Help, Ctxt, Response, MyString
Msg = "Do you want to continue?"
Style = vbYesNo + vbCritical + vbDefaultButton2
Title = "MsgBox Demonstration"
Help = "DEMO.HLP"
Ctxt = 1000
Response = MsgBox(Msg, Style, Title, Help, Ctxt)
If Response = vbYes Then ' User chose Yes.
MyString = "Yes" ' Perform some action.
Else ' User chose No.
MyString = "No" ' Perform some action.
End If