Função InputBox

  • Artigo

Exibe um prompt em uma caixa de diálogo, aguarda o usuário inserir texto ou clicar em um botão e retorna uma cadeia de caracteres com o conteúdo da caixa de texto.

Sintaxe

InputBox(prompt, [ title ], [ default ], [ xpos ], [ ypos ], [ helpfile, context ] )

A sintaxe da função InputBox possui estes argumentos nomeados:

Parte Descrição
prompt Obrigatório. Expressão de cadeia de caracteres exibida como a mensagem na caixa de diálogo. O comprimento máximo de prompt é aproximadamente 1024 caracteres, dependendo da largura dos caracteres usados. Se prompt consistir de 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 combinação de caracteres de retorno de carro e avanço de linha ((Chr(13) e (Chr(10)) entre cada linha.
title Opcional. Cadeia de caracteres exibida na barra de título da caixa de diálogo de expressão. Se você omitir title, o nome do aplicativo é colocado na barra de título.
default Opcional. Expressão de cadeia de caracteres exibida na caixa de texto como a resposta padrão, caso nenhuma outra entrada seja fornecida. Se você omitir 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 da 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 a um terço da altura da tela, de cima para baixo.
helpfile Opcional. Expressão de cadeia de caracteres que identifica o arquivo de ajuda a usar para oferecer ajuda contextual para a caixa de diálogo. Se helpfile for fornecido, context também deve ser fornecido.
context Opcional. Expressão numérica que é o número de contexto da Ajuda atribuído ao tópico da Ajuda apropriado pelo autor da Ajuda. Se context for fornecido, helpfile também deve ser fornecido.

Comentários

Quando tanto helpfile quanto context forem fornecidos, o usuário poderá pressionar F1 (Windows) ou HELP (Macintosh) para exibir o tópico da Ajuda correspondente ao context. Alguns aplicativos host, como o Microsoft Excel, também adicionam automaticamente um botão Ajuda à caixa de diálogo. Se o usuário escolher entre OK ou pressionar Enter, a função InputBox retornará o que estiver na caixa de texto. Se o usuário escolher Cancelar, a função retornará uma cadeia de comprimento zero ("").

A caixa de texto aceita apenas 255 caracteres. A cadeia de caracteres de retorno é truncada para 254 caracteres.

A caixa de texto não aceita quebras de linha, como Shift+Enter. Se o usuário colar texto com uma quebra de linha na caixa de texto, o texto será truncado na quebra de linha.

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

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 ele escolher OK ou pressionar a tecla Enter. Se o usuário escolher 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)

Confira também

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.