# win.ui.ctrl.combobox 库模块帮助文档

## win.ui.ctrl 成员列表 <a id="win.ui.ctrl" href="#win.ui.ctrl">&#x23;</a>

### win.ui.ctrl.combobox() <a id="win.ui.ctrl.combobox" href="#win.ui.ctrl.combobox">&#x23;</a>
下拉框控件  

[返回对象:comboboxObject](#comboboxObject)

## comboboxObject 成员列表 <a id="comboboxObject" href="#comboboxObject">&#x23;</a>

### comboboxObject._defWindowProc(hwnd,message,wParam,lParam) <a id="comboboxObject._defWindowProc" href="#comboboxObject._defWindowProc">&#x23;</a>
用于在 wndproc 回调中提前调用默认消息回调函数,  
所有窗口和控件定义了 wndproc 回调以后会自动创建这个函数,  
调用此函数以后,wndproc 必须指定非 null 返回值,  
以避免再次重复调用默认回调函数

### comboboxObject._parentForm <a id="comboboxObject._parentForm" href="#comboboxObject._parentForm">&#x23;</a>
返回创建控件的容器窗口（win.form对象），所有窗口控件都拥有此只读属性。  
对于使用窗体设计器创建的窗口，也就是返回设计时窗体容器。  

即使子窗口移除子窗口样式、更改父子关系，或以 orphanWindow显示，  
控件的 _parentForm 始终都不会改变  

[返回对象:winform](https://www.aardio.com/zh-cn/docs/library-reference/win/ui/_.html#winform)

### comboboxObject.add("文本") <a id="comboboxObject.add" href="#comboboxObject.add">&#x23;</a>
添加到组合框,  
支持0x100/*_CBS_SORT*/排序

### comboboxObject.addItems(字符串数组) <a id="comboboxObject.addItems" href="#comboboxObject.addItems">&#x23;</a>
添加字符串数组到组合框列表，  
数组元素将调用 tostring 转换为字符串后顺序添加到组合框列表尾部。

### comboboxObject.adjust <a id="comboboxObject.adjust" href="#comboboxObject.adjust">&#x23;</a>

```aardio
comboboxObject.adjust = function( cx,cy,wParam ) {	   
	/*父窗口改变大小后会自动触发此事件函数。  
注意 onSize 是 adjust 事件的别名，作用相同。  
所有 win.form 创建的窗体和控件都支持 adjust 事件,  
重复赋值 adjust 会追加事件触发器而非替换原来的值。  

cx 参数为窗口客户区宽度,cy 参数为窗口客户区高度,  
wParam 参数来自 _WM_SIZE 消息的 wParam 参数，一般不用管。  
一般不建议添加一个 wndproc 仅仅是为了处理  _WM_SIZE 消息，  
定义 adjust 事件是更好的选择。  

如果主动调用此函数，则检查并执行所有之前添加的 adjust 事件函数。  
省略调用参数时 cx,cy 参数默认设为窗口大小*/    
};
```

### comboboxObject.autoComplete <a id="comboboxObject.autoComplete" href="#comboboxObject.autoComplete">&#x23;</a>
用于onEditChange事件内部显示自动完成列表  
此函数会在显示列表后保持输入文本与光标不变  
仅适用于dropdown模式

### comboboxObject.autoComplete(items,selIndex) <a id="comboboxObject.autoComplete" href="#comboboxObject.autoComplete">&#x23;</a>

```aardio
items参数使用一个字符串数组指定要显示的列表项，  
@selIndex指定选项索引,不指定时默认为1
```

### comboboxObject.bottom <a id="comboboxObject.bottom" href="#comboboxObject.bottom">&#x23;</a>
底部坐标

### comboboxObject.capture <a id="comboboxObject.capture" href="#comboboxObject.capture">&#x23;</a>
是否捕获全局鼠标消息

### comboboxObject.className <a id="comboboxObject.className" href="#comboboxObject.className">&#x23;</a>
运行时类名

### comboboxObject.clear() <a id="comboboxObject.clear" href="#comboboxObject.clear">&#x23;</a>
清除组合框所有内容

### comboboxObject.close() <a id="comboboxObject.close" href="#comboboxObject.close">&#x23;</a>
关闭控件窗口

### comboboxObject.cls <a id="comboboxObject.cls" href="#comboboxObject.cls">&#x23;</a>
设计时类名

### comboboxObject.count <a id="comboboxObject.count" href="#comboboxObject.count">&#x23;</a>
列表项数目

### comboboxObject.delete(索引) <a id="comboboxObject.delete" href="#comboboxObject.delete">&#x23;</a>
删除参数指定索引的项，不指定参数时删除当前选中项。

### comboboxObject.dir("目录路径",_DDL_...) <a id="comboboxObject.dir" href="#comboboxObject.dir">&#x23;</a>
类似dir命令,列出指定目录下匹配的文件,支持通配符  
参数@2可指定选项,默认为 _DDL_READWRITE

### comboboxObject.disabled <a id="comboboxObject.disabled" href="#comboboxObject.disabled">&#x23;</a>
是否禁用

### comboboxObject.dropdown <a id="comboboxObject.dropdown" href="#comboboxObject.dropdown">&#x23;</a>
当前是否显示下拉列表。  
可用于获取或设置下拉框显示状态。

### comboboxObject.editBox <a id="comboboxObject.editBox" href="#comboboxObject.editBox">&#x23;</a>
返回下拉控件编辑框  

[返回对象:editObject](https://www.aardio.com/zh-cn/docs/library-reference/win/ui/ctrl/edit.html#editObject)

### comboboxObject.find <a id="comboboxObject.find" href="#comboboxObject.find">&#x23;</a>
查找列表项

### comboboxObject.find(...) <a id="comboboxObject.find" href="#comboboxObject.find">&#x23;</a>
可指定一个或多个字符串参数。  
自第 1 个参数开始查找以该字符串开始的项（忽略大小写，不使用模式匹配语法），  
找到就返回匹配项索引，找不到就继续查找下一个参数。  
失败返回数值 0 。

### comboboxObject.findEx(请输入文本) <a id="comboboxObject.findEx" href="#comboboxObject.findEx">&#x23;</a>
精确查找指定的项  
找不到返回0

### comboboxObject.getClientRect() <a id="comboboxObject.getClientRect" href="#comboboxObject.getClientRect">&#x23;</a>
控件客户区块位置(::RECT结构体)  

[返回对象:rectObject](https://www.aardio.com/zh-cn/docs/library-reference/global/_.html#rectObject)

### comboboxObject.getEditSel() <a id="comboboxObject.getEditSel" href="#comboboxObject.getEditSel">&#x23;</a>
仅适用 dropdown 模式：  
获取输入框选区起始位置,结束位置。  
选区包含起始与结束位置的字符，首字符位置为1  
开始位置在指定的字符前面,结束位置表示指定的字符后面  
只有一个返回值时表示无选区,并表示输入光标在指定字符后面  
返回0表示输入光标在最前面,并且无选区

### comboboxObject.getFont() <a id="comboboxObject.getFont" href="#comboboxObject.getFont">&#x23;</a>
控件字体(::LOGFONT结构体)  

[返回对象:logfontObject](#logfontObject)

### comboboxObject.getItemData(index) <a id="comboboxObject.getItemData" href="#comboboxObject.getItemData">&#x23;</a>
返回指定项索引绑定的数据对象。  
- 参数 @index 必须指定表示有效索引的数值。

### comboboxObject.getParent() <a id="comboboxObject.getParent" href="#comboboxObject.getParent">&#x23;</a>
返回父窗口  

[返回对象:staticObject](https://www.aardio.com/zh-cn/docs/library-reference/win/ui/ctrl/static.html#staticObject)

### comboboxObject.getPos() <a id="comboboxObject.getPos" href="#comboboxObject.getPos">&#x23;</a>
返回相对坐标,宽,高  
x,y,cx,cy=win.getPos(hwnd)

### comboboxObject.getRect() <a id="comboboxObject.getRect" href="#comboboxObject.getRect">&#x23;</a>
控件区块位置(::RECT结构体)

### comboboxObject.getRect(true) <a id="comboboxObject.getRect" href="#comboboxObject.getRect">&#x23;</a>
控件屏幕区块位置(::RECT结构体)

### comboboxObject.height <a id="comboboxObject.height" href="#comboboxObject.height">&#x23;</a>
高度

### comboboxObject.hwnd <a id="comboboxObject.hwnd" href="#comboboxObject.hwnd">&#x23;</a>
控件句柄

### comboboxObject.id <a id="comboboxObject.id" href="#comboboxObject.id">&#x23;</a>
控件ID

### comboboxObject.info() <a id="comboboxObject.info" href="#comboboxObject.info">&#x23;</a>
返回COMBOBOXINFO结构体,  
关于此结构体请查阅MSDN

### comboboxObject.insert("文本",插入位置) <a id="comboboxObject.insert" href="#comboboxObject.insert">&#x23;</a>
默认添加到开始处,  
-1表示添加到尾部  
不支持0x100/*_CBS_SORT*/排序

### comboboxObject.invalidate(/*可选使用::RECT()对象指定客户区*/) <a id="comboboxObject.invalidate(/*可选使用::RECT" href="#comboboxObject.invalidate(/*可选使用::RECT">&#x23;</a>
使窗口绘图区无效

### comboboxObject.invalidate(/*可选使用::RECT()对象指定客户区*/,0) <a id="comboboxObject.invalidate(/*可选使用::RECT" href="#comboboxObject.invalidate(/*可选使用::RECT">&#x23;</a>
使窗口绘图区无效  
不刷新背景

### comboboxObject.items <a id="comboboxObject.items" href="#comboboxObject.items">&#x23;</a>
获取或设置组合框列表，属性值为字符串数组，  

仅在属性面板设置初始化items属性时初始化selIndex为1，  
代码中动态修改items后请自行指定selIndex，  

如果自动指定了你不想要的selIndex，这会增加不必要的重绘。

### comboboxObject.left <a id="comboboxObject.left" href="#comboboxObject.left">&#x23;</a>
左侧坐标

### comboboxObject.limit <a id="comboboxObject.limit" href="#comboboxObject.limit">&#x23;</a>
只写属性,修改最大允许输入的文本长度。  
如果设为 0,则设定为默认长度 0x7FFFFFFE。  

在控件初始化参数中指定 `hscroll=true`（启用水平滚动条）才能支持 limit 属性。  
如果未启用横向滚动条，则可输入的文本不能超过最大可显示宽度。

### comboboxObject.listBox <a id="comboboxObject.listBox" href="#comboboxObject.listBox">&#x23;</a>
返回下拉控件列表框  

[返回对象:listboxObject](#listboxObject)

### comboboxObject.minVisible <a id="comboboxObject.minVisible" href="#comboboxObject.minVisible">&#x23;</a>
设置或获取下拉列表最小显示项目数，  
请在设计属性中启用垂直滚动条。  

如果不想多点一下，可如下改进此属性源码：  
util.metaProperty.extend(win.ui.ctrl.combobox,{  
	minVisible = {  
		_set = function( v ){   
			::SendMessageInt(owner.hwnd , 0x1701/*_CB_SETMINVISIBLE*/,v,0); 	  
		} 	  
	}  
})

### comboboxObject.modifyStyle(remove,add,swpFlags) <a id="comboboxObject.modifyStyle" href="#comboboxObject.modifyStyle">&#x23;</a>
修改窗口样式,所有参数都是可选参数,  
@remove 用数值指定要移除的样式,可使用 _WS_ 前缀的常量  
@add 用数值指定要添加的样式,可使用 _WS_ 前缀的常量  
@swpFlags 可选用数值指定调整窗口选项,可使用 _SWP_ 前缀的常量  
如果指定了 @swpFlag ,则使用该参数调用::SetWindowPos  
细节请参考 win.modifyStyle 函数源码

### comboboxObject.modifyStyleEx(remove,add,swpFlags) <a id="comboboxObject.modifyStyleEx" href="#comboboxObject.modifyStyleEx">&#x23;</a>
修改窗口扩展样式,所有参数都是可选参数,  
@remove 用数值指定要移除的样式,可使用 _WS_EX_ 前缀的常量  
@add 用数值指定要添加的样式,可使用 _WS_EX_ 前缀的常量  
@swpFlags 可选用数值指定调整窗口选项,可使用 _SWP_ 前缀的常量  
如果指定了 @swpFlag ,则使用该参数调用::SetWindowPos  
细节请参考 win.modifyStyle 函数源码

### comboboxObject.oncommand(id,event) <a id="comboboxObject.oncommand" href="#comboboxObject.oncommand">&#x23;</a>

```aardio
comboboxObject.oncommand = function(id,event){
    var text = owner.selText;
	/*响应事件，event比较常用的值：  
_CBN_SELCHANGE表示正在改变当前项,但下拉框还没有关闭  
_CBN_SELENDOK表示已改变选项且下拉框即将关闭  
注意事件中要用selText属性取新的值*/
}
```

### comboboxObject.orphanWindow(transparent,hwndBuddy) <a id="comboboxObject.orphanWindow" href="#comboboxObject.orphanWindow">&#x23;</a>
创建悬浮窗口,  
悬浮窗口仍然显示在原来的位置,  
悬浮窗口如影随形的跟随父窗口移动或改变大小,控件原来的固定边距等参数仍然有效  
此控件不建议指定参数

### comboboxObject.postMessage(msg,wParam,lParam) <a id="comboboxObject.postMessage" href="#comboboxObject.postMessage">&#x23;</a>
投递窗口消息到消息队列中  
此函数用法请参考 ::User32.PostMessage

### comboboxObject.redraw() <a id="comboboxObject.redraw" href="#comboboxObject.redraw">&#x23;</a>
刷新

### comboboxObject.right <a id="comboboxObject.right" href="#comboboxObject.right">&#x23;</a>
右侧坐标

### comboboxObject.selIndex <a id="comboboxObject.selIndex" href="#comboboxObject.selIndex">&#x23;</a>
获取或指定当前选中的项索引，属性值为数值。  
设为 null 取消选项。  

dropdown 模式下设置选项后默认会全选文本，  
可调用 setEditSel 方法设置或文本框取消选区。

### comboboxObject.selText <a id="comboboxObject.selText" href="#comboboxObject.selText">&#x23;</a>
读取或设置组合框当前选中文本  
在 onOk 事件回调中获取最新值应当使用selText而不是text属性

获取或指定当前选中的文本,精确匹配

### comboboxObject.selectString("文本前缀",开始索引) <a id="comboboxObject.selectString" href="#comboboxObject.selectString">&#x23;</a>
按文本前缀查找并选中项目,  
自开始索引后面开始查找,默认值为0也就是开始处搜索

### comboboxObject.sendMessage(msg,wParam,lParam) <a id="comboboxObject.sendMessage" href="#comboboxObject.sendMessage">&#x23;</a>
发送窗口消息  
此函数用法请参考 ::User32.SendMessage

### comboboxObject.setCueBannerText("提示文本") <a id="comboboxObject.setCueBannerText" href="#comboboxObject.setCueBannerText">&#x23;</a>
仅适用 dropdown 模式：  
指定文本框文本为空时的显示的默认提示文本,  
此函数会取消当前选中项,  
XP系统不支持此函数、但调用不报错

### comboboxObject.setCueBannerText(提示文本) <a id="comboboxObject.setCueBannerText" href="#comboboxObject.setCueBannerText">&#x23;</a>
设置文本为空的输入提示，  
参数 @1 使用字符串指定提示内容。  
此函数会自动设置控件 text 属性为空

### comboboxObject.setEditSel(当前位置) <a id="comboboxObject.setEditSel" href="#comboboxObject.setEditSel">&#x23;</a>
仅适用 dropdown 模式：  
设置输入框为无选区。  
移动光标到指定位置的字符后面

### comboboxObject.setEditSel(起始位置,结束位置) <a id="comboboxObject.setEditSel" href="#comboboxObject.setEditSel">&#x23;</a>
仅适用 dropdown 模式：  
设置输入框选区,以字符为单位。  
首字符位置为 1 ，选区包含起始与结束位置  
如果结束位置小于开始位置,自动交换参数位置

### comboboxObject.setFocus() <a id="comboboxObject.setFocus" href="#comboboxObject.setFocus">&#x23;</a>
设置焦点

### comboboxObject.setFont(指定字体) <a id="comboboxObject.setFont" href="#comboboxObject.setFont">&#x23;</a>
指定LOGFONT字体对象,或逻辑字体句柄

### comboboxObject.setFont(混入字体属性) <a id="comboboxObject.setFont" href="#comboboxObject.setFont">&#x23;</a>

```aardio
comboboxObject.setFont(point=10;name="宋体");
```

### comboboxObject.setItemData(index,data) <a id="comboboxObject.setItemData" href="#comboboxObject.setItemData">&#x23;</a>
绑定参数 @data 指定的数据对象到参数 @index 指定的项索引。  
- 参数 @index 请指定数值，省略取当前项。  
- 参数 @data 可指定任意数据类型的对象。  

对 items 赋值或者调用 clear 方法都会将清空自定义数据。  
delete 方法会同时删除绑定的自定义数据。

### comboboxObject.setParent(控件对象) <a id="comboboxObject.setParent" href="#comboboxObject.setParent">&#x23;</a>
改变父窗口

### comboboxObject.setPos(x坐标,y坐标,宽,高,插入位置,参数) <a id="comboboxObject.setPos" href="#comboboxObject.setPos">&#x23;</a>
调整窗口位置或排序,所有参数可选  
同时指定x,y坐标则移动位置  
同时指定宽高则改变大小  
指定插入位置(句柄或_HWND前缀常量)则调整Z序

### comboboxObject.setRect(rc) <a id="comboboxObject.setRect" href="#comboboxObject.setRect">&#x23;</a>
设置控件区块位置(::RECT结构体)

### comboboxObject.setRect(rc,true) <a id="comboboxObject.setRect" href="#comboboxObject.setRect">&#x23;</a>
设置控件屏幕区块位置(::RECT结构体)

### comboboxObject.show(true) <a id="comboboxObject.show" href="#comboboxObject.show">&#x23;</a>
显示控件

### comboboxObject.tabNext() <a id="comboboxObject.tabNext" href="#comboboxObject.tabNext">&#x23;</a>
[返回对象:staticObject](https://www.aardio.com/zh-cn/docs/library-reference/win/ui/ctrl/static.html#staticObject)

### comboboxObject.tabNext(移动焦点,是否反向) <a id="comboboxObject.tabNext" href="#comboboxObject.tabNext">&#x23;</a>
获取下一个支持tab控制焦点的控件  
参数@1为true会自动移动焦点到该控件  
参数@2为true则获取上一个控件,否则获取下一个控件

### comboboxObject.text <a id="comboboxObject.text" href="#comboboxObject.text">&#x23;</a>
组合框当前输入文本  
在 onOk 事件回调中获取最新值应当使用 selText 而不是 text 属性

### comboboxObject.theme <a id="comboboxObject.theme" href="#comboboxObject.theme">&#x23;</a>
外观主题,例如  
winform.button.theme = "Explorer"  
winform.button.theme = false

### comboboxObject.threadCallable() <a id="comboboxObject.threadCallable" href="#comboboxObject.threadCallable">&#x23;</a>
开启此控件的跨线程调用功能

### comboboxObject.top <a id="comboboxObject.top" href="#comboboxObject.top">&#x23;</a>
顶部坐标

### comboboxObject.topIndex <a id="comboboxObject.topIndex" href="#comboboxObject.topIndex">&#x23;</a>
获取此属性返回首个可见项索引，  
设置此属性为项目索引则滚动到该项可见。  
项目起始索引为 1

### comboboxObject.update() <a id="comboboxObject.update" href="#comboboxObject.update">&#x23;</a>
重绘invalidate函数指定的区块

### comboboxObject.valid <a id="comboboxObject.valid" href="#comboboxObject.valid">&#x23;</a>
窗口是否有效，  
窗口未关闭返回 true ，  
窗口已关闭或正在关闭返回 false

### comboboxObject.visible <a id="comboboxObject.visible" href="#comboboxObject.visible">&#x23;</a>
当前控件窗口是否显示。  
仅检查当前窗口的可见性样式（窗口 是否具有 _WS_VISIBLE 样式）。  
不考虑父窗口是否可见，不考虑是否被其他窗口遮挡。  
如果需要同时判断父窗口的可见性，应改用 win.isVisible 函数。

### comboboxObject.width <a id="comboboxObject.width" href="#comboboxObject.width">&#x23;</a>
宽度

## comboboxObject 事件列表 <a id="comboboxObjectEvent" href="#comboboxObjectEvent">&#x23;</a>

### comboboxObject.onCancel() <a id="comboboxObject.onCancel" href="#comboboxObject.onCancel">&#x23;</a>

```aardio
comboboxObject.onCancel = function(){ 
	/*响应事件，用户未确认选项且且下拉框即将关闭  
例如用户点击其他控件关闭下拉列表或直接关闭窗口*/
}
```

### comboboxObject.onCloseUp() <a id="comboboxObject.onCloseUp" href="#comboboxObject.onCloseUp">&#x23;</a>

```aardio
comboboxObject.onCloseUp = function(){ 
	/*下拉列表隐藏时触发此事件*/
}
```

### comboboxObject.onDropDown() <a id="comboboxObject.onDropDown" href="#comboboxObject.onDropDown">&#x23;</a>

```aardio
comboboxObject.onDropDown = function(){ 
	/*弹出下拉列表前触发此事件  
用代码修改 dropdown 属性也会触发此事件*/
}
```

### comboboxObject.onEditChange() <a id="comboboxObject.onEditChange" href="#comboboxObject.onEditChange">&#x23;</a>

```aardio
comboboxObject.onEditChange = function(){ 
	/*响应事件，输入框中的文本已变更,  
只有用户输入时才会触发,  
切换选项或使用代码修改text属性不会触发  
注意使用text属性取最新值*/
}
```

### comboboxObject.onFocusGot() <a id="comboboxObject.onFocusGot" href="#comboboxObject.onFocusGot">&#x23;</a>

```aardio
comboboxObject.onFocusGot = function(){ 
	/*下拉框获得焦点时触发此事件*/
}
```

### comboboxObject.onFocusLost() <a id="comboboxObject.onFocusLost" href="#comboboxObject.onFocusLost">&#x23;</a>

```aardio
comboboxObject.onFocusLost = function(){ 
	/*下拉框失去焦点时触发此事件*/
}
```

### comboboxObject.onOk() <a id="comboboxObject.onOk" href="#comboboxObject.onOk">&#x23;</a>

```aardio
comboboxObject.onOk = function(){ 
	/*响应事件，用户已确认选择指定选项,  
注意事件中要用 selText 属性取新的值  
单击选项或在选项上回车都会触发此事件（无论是否改变选项）*/
}
```

### comboboxObject.onSelChange() <a id="comboboxObject.onSelChange" href="#comboboxObject.onSelChange">&#x23;</a>

```aardio
comboboxObject.onSelChange = function(){ 	
	/*改变当前选项触发此事件。  
在下拉框上按方向键调整当前选项会触发此事件，  
在选项上回车确认选项时，如果选项已改变则会触发此事件，  
如果回车操作未改变选项仅触发 onOk 事件。  

注意事件中要用 selText 属性取新的值  
使用代码修改 selIndex 时不会触发*/
}
```

### comboboxObject.onSize <a id="comboboxObject.onSize" href="#comboboxObject.onSize">&#x23;</a>

```aardio
comboboxObject.onSize = function( width,height,wParam ) {	   
	/*父窗口改变大小后会自动触发此事件函数。  
注意 onSize 是 adjust 事件的别名，作用相同  
所有 win.form 创建的窗体和控件都支持 onSize（或 adjust）事件,  
重复赋值 onSize（或 adjust）会追加事件触发器而非替换原来的值。  

width 参数为窗口客户区宽度,height 参数为窗口客户区高度,  
wParam 参数来自 _WM_SIZE 消息的 wParam 参数，一般不用管。  
一般不建议添加一个 wndproc 仅仅是为了处理  _WM_SIZE 消息，  
定义 onSize 事件是更好的选择。  

};*/
```

### 自动完成常量
_CBN_CLOSEUP=8  
_CBN_DBLCLK=2  
_CBN_DROPDOWN=7  
_CBN_EDITCHANGE=5  
_CBN_EDITUPDATE=6  
_CBN_KILLFOCUS=4  
_CBN_SELCHANGE=1  
_CBN_SELENDCANCEL=0xA  
_CBN_SELENDOK=9  
_CBN_SETFOCUS=3  
