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 que contém o conteúdo da caixa de texto.
Sintaxe
InputBox(prompt [, title ] [, default ] [, xpos ] [, ypos ] [, helpfile ] [, context ] )
A sintaxe da função CaixaDeEntrada tem estes argumentos:
| Argumento | Descrição |
|---|---|
| prompt | Obrigatório. Expressão de cadeia de caracteres exibida como a mensagem na caixa de diálogo. O comprimento máximo do prompt é de aproximadamente 1024 caracteres, dependendo da largura dos caracteres usados. 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 alimentação 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. |
| o título | Opcional. Expressão de cadeia de caracteres exibida na barra de título da caixa de diálogo. Se você omitir o título, o nome do aplicativo será colocado na barra de título. |
| padrão | Opcional. Expressão de cadeia de caracteres exibida na caixa de texto como a resposta padrão se nenhuma outra entrada for fornecida. Se você omitir o padrão, a caixa de texto será exibida vazia. |
| XPOS | Opcional. Expressão numérica que especifica, em twips, a distância horizontal da borda esquerda da caixa de diálogo em relação à borda esquerda da tela. Se xpos for omitido, a caixa de diálogo será centralizada horizontalmente. |
| ypos | Opcional. Expressão numérica que especifica, em twips, a distância vertical da borda superior da caixa de diálogo da parte superior da tela. Se ypos for omitido, a caixa de diálogo será posicionada verticalmente aproximadamente um terço da tela. |
| arquivo de ajuda | Opcional. Expressão de cadeia de caracteres que identifica o arquivo de Ajuda a ser usado para fornecer Ajuda contextual para a caixa de diálogo. Se 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 apropriado da Ajuda pelo autor da Ajuda. Se o contexto for fornecido, o helpfile também deverá ser fornecido. |
Comentários
Quando helpfile e context são fornecidos, o usuário pode pressionar F1 (Windows) ou HELP (Macintosh) para exibir o tópico da Ajuda correspondente ao contexto. Alguns aplicativos host também adicionam automaticamente um botão Ajuda à caixa de diálogo. Se o usuário clicar em OK ou pressionar ENTER, a função InputBox retornará o que estiver na caixa de texto. Se o usuário clicar em Cancelar, a função retornará uma cadeia de comprimento zero ("").
Observação
Para especificar mais do que o primeiro argumento nomeado, você deve usar InputBox em uma expressão. Para omitir alguns argumentos posicionais, você deve incluir o delimitador de vírgula correspondente.
Exemplo
Observação
Os exemplos a seguir demonstram o uso dessa função em um módulo do Visual Basic for Applications (VBA). Para obter mais informações sobre como trabalhar com o VBA, selecione Referência do desenvolvedor na lista suspensa ao lado de Pesquisar e insira 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 será centralizada automaticamente para os respectivos 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 usuário clicar em Cancelar, uma cadeia de comprimento zero será retornada.
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)