インプットボックス(InputBox関数)

最終更新日：2019-06-29

第24回.インプットボックス(InputBox関数)

ダイアログボックスにメッセージとテキストボックスを表示し、
ユーザーが入力した文字列を取得することが出来ます。

マクロVBAの最初または途中で、ユーザーの入力によって処理を変更したい場合が出てきます。
これを実現するには、マクロVBAではInputBox関数を使います。

InputBox関数の構文

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

prompt	必ず指定します。ダイアログボックス内にメッセージとして表示する文字列を示す文字列式を指定します。名前付き引数 prompt に指定できる最大文字数は、1 バイト文字で約 1,024 文字です。ただし、使う文字の文字幅に依存します。名前付き引数 prompt に複数行を指定する場合は、キャリッジリターン (Chr(13))、ラインフィード (Chr(10))、またはキャリッジリターンとラインフィードの組み合わせ (Chr(13) & Chr(10)) を改行する位置に挿入し、行を区切ってください。
title	省略可能です。ダイアログボックスのタイトルバーに表示する文字列式を指定します。名前付き引数 title を省略すると、タイトルバーにはアプリケーション名が表示されます。
default	省略可能です。ユーザーが何も入力しない場合に、テキストボックスに既定値として表示する文字列式を指定します。名前付き引数 default を省略すると、テキストボックスには何も表示されません。
xpos	省略可能です。画面の左端からダイアログボックスの左端までの水平方向の距離を、twip単位で示す数式を指定します。名前付き引数 xposを省略すると、ダイアログボックスは水平方向に対して画面の中央の位置に配置されます。
ypos	省略可能です。画面の上端からダイアログボックスの上端までの垂直方向の距離を、twip単位で示す数式を指定します。名前付き引数 ypos 省略すると、ダイアログボックスは垂直方向に対して画面の上端から約 1/3 の位置に配置されます。
helpfile	省略可能です。ダイアログボックスに状況依存のヘルプを設定するために、使用するヘルプファイルの名前を示す文字列式を指定します。この引数は、表示するダイアログボックスの説明を、ヘルプを使って表示するときに指定します。名前付き引数 helpfile を指定した場合は、名前付き引数contextも指定する必要があります。
context	省略可能です。ヘルプトピックに指定したコンテキスト番号を表す数式を指定します。名前付き引数 context を指定した場合は、名前付き引数 helpfile も指定する必要があります。

引数は、名前付き引数が使用できます。

helpfile、contextはヘルプなので、あまり使わないと思いますので、説明を省きます。

名前付き引数

あらかじめ定義された名前を持つ引数。
名前付き引数を使用すると、構文どおりに指定された順序で各引数に値を指定しなくても、任意の順序で値を設定することができます。

※名前付き引数については、後々詳しく説明します。
第25回.名前付き引数について

引数とは、関数やメソッド等を呼び出すときに渡す値の指定のことです。この引数を渡す時の記述方法として、名前付き引数があります。マクロVBAでの記述では、:=が使われます。この:=は名前付き引数のみで使用される記述になります。

しかし、InputBoxでは、名前付き引数を使わずに、順番通りに指定すれば良いでしょう。

InputBox関数の例文


  
    
      Dim strIn As String

      strIn = 
InputBox("何か入力して下さい。")

メッセージのみ指定した場合です。
ダイアログ画面の表示内容を確認して下さい。


  
    
      Dim strIn As String

      strIn = InputBox("何か入力して下さい。" & vbLf & vbLf & "入力サンプルをここに書きます。")

複数行のメッセージを指定した場合です。


  
    
      Dim strIn As String

      strIn = InputBox("何か入力して下さい。", "ユーザー入力", 
"規定文字")

メッセージ、タイトル、規定値をした場合です。
ダイアログ画面の表示内容を確認して下さい。
何も入力されなかったか、「キャンセル」ボタンが押された場合の対処。


  
    
      Dim strIn As String

      strIn = InputBox("何か入力して下さい。", "ユーザー入力", 
"規定文字")

      If strIn = "" Then

      　　MsgBox "何も入力されませんでした。"

      End If

何も入力されなかったか、「キャンセル」ボタンが押された場合は、空白が返されます。
従って、受け取った変数を、""で判定すれば良いです。

[, xpos] [, ypos]について

表示位置の指定です。
サンプル表示しても意味が無いので省略します。
ただし、通常は真ん中に表示されるので特に指定はしません。
指定数値はtwipなので、VBAでは管理が難しいものになりますので、ここでは省略します。
実務的には左上に表示するくらいでしょうか、その場合は0,0を指定すれば良いです。