# win.inputBox 库模块帮助文档

## win 成员列表 <a id="win" href="#win">&#x23;</a>

### win.inputBox <a id="win.inputBox" href="#win.inputBox">&#x23;</a>
输入对话框。  
导入此库以后自动为所有窗口或控件对象添加 inputBox 函数。  
窗体控件的 inputBox 成员函数不需要指定父窗体参数，且直接返回输入结果。  
例如调用 winform.inputBox 方法可直接获取用户输入，  
但是调用 win.inputBox 构造函数返回的是窗体对象。

创建输入对话框。

### win.inputBox() <a id="win.inputBox" href="#win.inputBox">&#x23;</a>
[返回对象:wininputBoxObject](#wininputBoxObject)

### win.inputBox(parent,prompt,title,default,cueBannerText,password) <a id="win.inputBox" href="#win.inputBox">&#x23;</a>
创建输入对话框，返回 win.form 对象。  
- @parent 参数指定父窗体或控件对象，必填。  
- @prompt 参数指定在输入框上面一排显示的输入提示，单行文本，必填。  
- @title 参数指定对输入对话框窗口标题，可选。  
- @default 参数指定输入框中显示的默认文本，可选。  
- @cueBannerText 参数指定输入框为空时在输入框内部以浅色字体显示的提示，可选。  
- @password 参数输入字符是否显示为星号，可选。  
如果 @prompt 参数包含"密码","密钥","password"则 @password 默认为 true。

## wininputBoxObject 成员列表 <a id="wininputBoxObject" href="#wininputBoxObject">&#x23;</a>

### wininputBoxObject.bgcolor <a id="wininputBoxObject.bgcolor" href="#wininputBoxObject.bgcolor">&#x23;</a>
设置窗口背景颜色。  
使用 GDI 颜色值，例如 0xFFFFFF 为白色

### wininputBoxObject.center() <a id="wininputBoxObject.center" href="#wininputBoxObject.center">&#x23;</a>
居中显示

### wininputBoxObject.changeInterval(请输入ID,1000) <a id="wininputBoxObject.changeInterval" href="#wininputBoxObject.changeInterval">&#x23;</a>
重新设定定时器的延时时间

### wininputBoxObject.clearInterval(请输入ID) <a id="wininputBoxObject.clearInterval" href="#wininputBoxObject.clearInterval">&#x23;</a>
删除定时器

### wininputBoxObject.doModal() <a id="wininputBoxObject.doModal" href="#wininputBoxObject.doModal">&#x23;</a>
弹出输入对话框  
该函数返回用户输入的值  
取消则返回null空值

### wininputBoxObject.dpiScale(x,y) <a id="wininputBoxObject.dpiScale" href="#wininputBoxObject.dpiScale">&#x23;</a>
将 @x,@y 表示的像素值乘以窗体当前 DPI 缩放倍数并返回,  
省略 @y 参数时仅返回 @x 转换后的值

### wininputBoxObject.getPos() <a id="wininputBoxObject.getPos" href="#wininputBoxObject.getPos">&#x23;</a>
返回相对坐标,宽,高

### wininputBoxObject.info <a id="wininputBoxObject.info" href="#wininputBoxObject.info">&#x23;</a>
[返回对象:editObject](https://www.aardio.com/zh-cn/doc/library-reference/win/ui/ctrl/edit.html#editObject)

### wininputBoxObject.input <a id="wininputBoxObject.input" href="#wininputBoxObject.input">&#x23;</a>
[返回对象:editObject](https://www.aardio.com/zh-cn/doc/library-reference/win/ui/ctrl/edit.html#editObject)

### wininputBoxObject.modifyStyle(remove,add,swpFlags) <a id="wininputBoxObject.modifyStyle" href="#wininputBoxObject.modifyStyle">&#x23;</a>
修改窗口样式,所有参数都是可选参数,  
@remove 用数值指定要移除的样式,可使用 _WS_ 前缀的常量  
@add 用数值指定要添加的样式,可使用 _WS_ 前缀的常量  
@swpFlags 可选用数值指定调整窗口选项,可使用 _SWP_ 前缀的常量  
如果指定了 @swpFlag ,则使用该参数调用::SetWindowPos  
细节请参考 win.modifyStyle 函数源码

### wininputBoxObject.modifyStyleEx(remove,add,swpFlags) <a id="wininputBoxObject.modifyStyleEx" href="#wininputBoxObject.modifyStyleEx">&#x23;</a>
修改窗口扩展样式,所有参数都是可选参数,  
@remove 用数值指定要移除的样式,可使用 _WS_EX_ 前缀的常量  
@add 用数值指定要添加的样式,可使用 _WS_EX_ 前缀的常量  
@swpFlags 可选用数值指定调整窗口选项,可使用 _SWP_ 前缀的常量  
如果指定了 @swpFlag ,则使用该参数调用::SetWindowPos  
细节请参考 win.modifyStyle 函数源码

### wininputBoxObject.setInterval(回调函数,延时毫秒数,...) <a id="wininputBoxObject.setInterval" href="#wininputBoxObject.setInterval">&#x23;</a>

```aardio
wininputBoxObject.setInterval(回调函数,延时毫秒数,...setInterval(   
	function(){  
		/*参数@1指定执行函数,参数@2指定执行间隔，  
可选指定一个或多个回调参数，不指定回调参数则默认为:  
 hwnd,message,timerId,tick,  

如果在定时器中执行了win.delay等继续消息循环的代码，  
在定时器退出前不会再触发同一定时器（重入）。  

定时器回调函数返回数值可修改时间间隔,  
返回false取消该定时器*/  
	},1000   
)
```

### wininputBoxObject.setPos(x,y,宽,高,插入位置,参数) <a id="wininputBoxObject.setPos" href="#wininputBoxObject.setPos">&#x23;</a>
调整窗口位置或排序  
所有参数可选

### wininputBoxObject.setTimeout(函数名,延时,其他参数) <a id="wininputBoxObject.setTimeout" href="#wininputBoxObject.setTimeout">&#x23;</a>
延时执行函数

### wininputBoxObject.text <a id="wininputBoxObject.text" href="#wininputBoxObject.text">&#x23;</a>
输入框标题

### wininputBoxObject.topmost() <a id="wininputBoxObject.topmost" href="#wininputBoxObject.topmost">&#x23;</a>
窗体始终最前

### wininputBoxObject.topmost(false) <a id="wininputBoxObject.topmost" href="#wininputBoxObject.topmost">&#x23;</a>
取消窗体始终最前

### wininputBoxObject.width <a id="wininputBoxObject.width" href="#wininputBoxObject.width">&#x23;</a>
设置对话框宽度。  

在窗口显示或其他方式自动或手动调用 enableDpiScaling 前修改此值，  
则会在 enableDpiScaling 被调用时自动缩放，  
否则设置或获取当前真实宽度。  

可调用 dpiScale 函数获取缩放后的宽度

## wininputBoxObject 事件列表 <a id="wininputBoxObjectEvent" href="#wininputBoxObjectEvent">&#x23;</a>

### wininputBoxObject.onInitDialog <a id="wininputBoxObject.onInitDialog" href="#wininputBoxObject.onInitDialog">&#x23;</a>

```aardio
wininputBoxObject.onInitDialog = function(hwnd,message,wParam,lParam){  
	wininputBoxObject.center()/*输入框初始化完成触发该函数*/  
}
```

