Apresenta um pedido numa caixa de diálogo, aguarda que o utilizador introduza texto ou clique num botão e devolve uma Cadeia que contém o conteúdo da caixa de texto.
Sintaxe
InputBox ( prompt [, title ] [, default ] [, xpos ] [, ypos ] [, helpfile ] [, context ] )
A sintaxe da função InputBox 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 uma combinação de carateres return-linefeed (Chr(13) & Chr(10)) entre cada linha. |
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. |
padrão |
Opcional. Expressão de cadeia apresentada na caixa de texto como a resposta predefinida se não for fornecida nenhuma outra entrada. Se omitir a predefinição, a caixa de texto será apresentada vazia. |
xpos |
Opcional. Expressão numérica que especifica, em twips, a distância horizontal do limite esquerdo da caixa de diálogo a partir da margem esquerda do ecrã. Se xpos for omitido, a caixa de diálogo será centrada horizontalmente. |
ypos |
Opcional. Expressão numérica que especifica, em twips, a distância vertical da margem superior da caixa de diálogo a partir da parte superior do ecrã. Se ypos for omitido, a caixa de diálogo é verticalmente posicionada aproximadamente um terço do caminho para baixo no ecrã. |
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. |
Comentários
Quando o ficheiro de ajuda e o contexto são fornecidos, o utilizador pode premir F1 (Windows) ou HELP (Macintosh) para ver o tópico de Ajuda correspondente ao contexto. Alguns aplicativo host também adicionam automaticamente um botão Ajuda à caixa de diálogo. Se o utilizador clicar em OK ou premir ENTER, a função Caixa de Entrada devolve o que estiver na caixa de texto. Se o utilizador clicar em Cancelar, a função devolve uma cadeia de comprimento zero ("").
Observação: Para especificar mais do que o primeiro argumento nomeado, tem de utilizar a Caixa de Entrada 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). Para obter mais informações sobre como trabalhar com o VBA, selecione Referência do Programador na lista pendente junto a Procurar e introduza um ou mais termos na caixa de pesquisa.
Este exemplo mostra várias formas de utilizar a função InputBox para pedir ao utilizador para introduzir um valor. Se as posições x e y forem omitidas, a caixa de diálogo será automaticamente centrada nos respetivos eixos. A variável MyValue contém o valor introduzido pelo utilizador se o utilizador clicar em OK ou premir a tecla ENTER. Se o utilizador clicar em Cancelar, é devolvida uma cadeia de comprimento zero.
Dim Message, Title, Default, MyValue
Message = "Enter a value between 1 and 3" ' Set prompt.
Title = "InputBox Demo" ' Set title.
Default = "1" ' Set default.
' Display message, title, and default value.
MyValue = InputBox(Message, Title, Default)
' Use Helpfile and context.
' The Help button is added automatically.
MyValue = InputBox(Message, Title,,,,"DEMO.HLP", 10)
' Display dialog box at position 100, 100.
MyValue = InputBox(Message, Title, Default, 100, 100)