Exibe um prompt em uma caixa de diálogo, aguarda que o usuário insira texto ou clique em um botão e retorna uma String contendo o conteúdo da caixa de texto.
Sintaxe
InputBox(prompt [, título ] [, padrão ] [, xpos ] [, ypos ] [, helpfile ] [, contexto ] )
A sintaxe da função InputBox tem estes argumentos:
| Argumento | Descrição |
|---|---|
| prompt | 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 prompt consistir em mais de uma linha, você poderá separar as linhas usando um caractere de retorno de carro (Chr(13)), um caractere de avanço de linha (Chr(10)) ou uma combinação de caracteres de retorno de carro-linha (Chr(13) & Chr(10)) entre cada linha. |
| título | 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. |
| predefinição | Opcional. Expressão de cadeia apresentada na caixa de texto como resposta predefinida, caso não sejam fornecidas quaisquer outras entradas. 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 entre a margem esquerda da caixa de diálogo e a margem esquerda do ecrã. Se xpos for omitido, a caixa de diálogo é centrada horizontalmente. |
| ypos | Opcional. Expressão numérica que especifica, em twips, a distância vertical entre a margem superior da caixa de diálogo e a parte superior do ecrã. Se ypos for omitido, a caixa de diálogo é posicionada verticalmente aproximadamente um terço do caminho abaixo da tela. |
| 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 o helpfile for fornecido, o contexto também deverá 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 ficheiro de ajuda também tem de ser fornecido. |
Observações
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. Algumas aplicações anfitriãs também adicionam automaticamente um botão Ajuda à caixa de diálogo. Se o utilizador clicar em OK ou premir ENTER, a função InputBox devolve o que estiver na caixa de texto. Se o utilizador clicar em Cancelar, a função devolve uma cadeia de comprimento zero ("").
Nota
Para especificar mais do que o primeiro argumento com nome, tem de utilizar InputBox numa expressão. Para omitir alguns argumentos posicionais, tem de incluir o delimitador de vírgulas correspondente.
Exemplo
Nota
Os exemplos seguintes demonstram a utilização desta função no módulo VBA (Visual Basic for Applications). Para obter mais informações sobre como trabalhar com o VBA, selecione Referência para Programadores na lista pendente junto a Procurar e introduza um ou mais termos na caixa de pesquisa.
Este exemplo mostra várias maneiras de usar a função InputBox para solicitar que o usuário insira um valor. Se as posições x e y forem omitidas, a caixa de diálogo é automaticamente centrada nos respetivos eixos. A variável MyValue contém o valor inserido pelo usuário se o usuário clicar em OK ou pressionar 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)