# InputBox

显示输入框让用户输入字符串.

    InputBox, OutputVar , Title, Prompt, HIDE, Width, Height, X, Y, Locale, Timeout, Default

## 参数

OutputVar

  用来保存用户输入文本的变量名.

Title

  输入框的标题. 如果为空或省略, 则默认为脚本的名称.

Prompt

  输入框的文本, 通常是用于提示用户期望输入的数据类型的信息. 如果 Prompt 较长, 可以通过延续片段的方法将其分解成较短的几行, 这样可以增加可读性和可维护性.

HIDE

  如果此参数为 HIDE, 则屏蔽用户的输入, 这可以用于输入密码.

Width

  如果此参数为空或省略, 则窗口的初始宽度为 375. 此参数可以为表达式.

Height

  如果此参数为空或省略, 则窗口的初始高度为 189. 此参数可以为表达式.

X, Y

  窗口的 X 和 Y 坐标 (使用 0, 0 来将其移动到桌面的左上角), 可以为表达式. 如果其中一个坐标为空或省略, 则对话框在这个方向上将居中. 其中一个或两个坐标都可以为负数来把窗口部分或完全移出桌面.

Locale [v1.1.31+]

  如果这个参数是单词 Locale, OK 和 Cancel 按钮将根据当前用户的 locale 来命名(例如, 在中文系统中使用取消来代替 Cancel). 此外, 为了正确显示这些名称, 将按钮加宽, 并增加输入框的最小宽度. 这成为 AutoHotkey v2 中的默认行为.

Timeout

  以秒为单位的超时时间(可以为小数或表达式). 如果这个值超过 2147483(24.8 天), 那么它会被设置为 2147483. 达到超时时间后, 输入框窗口会自动关闭同时把 ErrorLevel 设置为 2. OutputVar 仍会被设置为用户输入的内容.

Default

  对话框首次出现时显示在输入框中的字符串. 用户可以使用退格或其他方法修改这个字符串.

## 错误处理

[v1.1.04+]: 此命令失败时会抛出异常. 想了解更多信息, 请参阅运行时错误.

当用户按下取消按钮时 ErrorLevel 值被设置为 1, 按下确定时值为 0, 如果对话框超时则为 2. 在这三种情况中, OutputVar 都被设置为输入的值. 这使得 CANCEL 按钮执行其他的功能而不是脚本设计者期望的取消功能.

## 备注

输入框通常看起来像这样:

此对话框允许用户输入文本然后按下 OK 或 CANCEL. 用户可以通过拖动对话框的边界来调整它的大小.

GUI 窗口可以使用 Gui +OwnDialogs 的方法显示模式输入框. 模式输入框在其消失之前会阻止用户与 GUI 窗口进行交互.

## 相关

GUI, Input, MsgBox, FileSelectFile, FileSelectFolder, SplashTextOn, ToolTip

## 示例

允许用户输入隐藏的密码.

    InputBox, password, Enter Password, (your input will be hidden), hide

允许用户输入电话号码.

    InputBox, UserInput, Phone Number, Please enter a phone number., , 640, 480
    if ErrorLevel
        MsgBox, CANCEL was pressed.
    else
        MsgBox, You entered "%UserInput%"

dftg