# GuiControlGet

获取 GUI 窗口中控件的各种类型的信息.

    GuiControlGet, OutputVar , SubCommand, ControlID, Value

## 参数

OutputVar
  用来存储子命令结果的变量名.
SubCommand, Value
  它们相互依赖, 其用法描述如下.
ControlID

  如果为空或省略, 则使用指定的输出变量名. 例如, `GuiControlGet, MyEdit` 等同于 `GuiControlGet, MyEdit,, MyEdit`.

  如果目标控件有关联变量, 则指定此变量名作为 ControlID(此方法优先于下面描述的那个). 由于这个原因, 通常最好给每个之后要使用 GuiControl 或 GuiControlGet 访问的控件分配一个变量, 即使那个控件不是可输入型(例如 GroupBox 或 Text).

  或者 ControlID 可以是 ClassNN(控件的类名和实例编号) 或控件的文本, 它们都可以通过 Window Spy 获取. 使用文本时, 匹配行为由 SetTitleMatchMode 决定.

  注意: 图片控件的文件名(和控件创建时指定的一样) 可以作为 ControlID 使用.

  [v1.1.04+]: ControlID 可以为某个控件的 HWND .

  如果控件不在默认 GUI 中, 那么 必须设置 GUI 的名称 -- 除非在 [v1.1.20+] 版本中, ControlID 参数为 HWND, 因为每个 HWND 都是唯一值. 详情参见备注 .

## 子命令

对于 SubCommand, 指定以下命令之一:

- (Blank): 检索(获取) 控件的内容.
- Pos: 检索控件的位置和大小.
- Focus: 检索当前含键盘焦点的控件的标识符(ClassNN).
- FocusV [v1.0.43.06+]: 检索焦点控件的关联变量的名称.
- Enabled: 如果控件是启用的检索 1, 或者如果是禁用的检索 0.
- Visible: 如果控件是可见的检索 1, 或者如果是隐藏的检索 0.
- Hwnd [v1.0.46.16+]: 检索控件的窗口句柄(HWND).
- Name [v1.1.03+]: 检索控件的关联变量名.

### (Blank)

检索控件的内容.

    GuiControlGet, OutputVar ,, ControlID, Value

留空 SubCommand, 来获取控件的内容. 除了下面的控件类型, 其他的都是无须解释的:

Picture: 获取控件创建时最初指定的图片文件名. 即使指定了新的图片文件名, 此名称也不会改变.

Edit: 获取控件的内容, 但文本中断行的位置表示为单独的换行符(`n) 而不是非 GUI 命令(例如 ControlGetText 和 ControlSetText) 使用的传统 CR+LF(`r`n).

Hotkey: 如果控件中不含控件, 则获取到空值. 否则它获取到修饰符和键名. 例如: `^!C`, `^Home`, `+^NumpadHome`.

Checkbox/Radio: 控件被选中时获取的值为 1, 未选中时为 0, 而灰色状态时为 -1. 要获取控件的文本/标题, 请指定单词 Text 到 Value. 注: 与 Gui Submit 不同, 单选按钮的状态总是单独获取的, 不论它们是否在单选按钮组中.

UpDown/Slider/Progress: 获取控件的当前位置.

Tab/DropDownList/ComboBox/ListBox: 获取当前选择的项目/选项卡的文本(如果控件含有 AltSubmit 则为其位置). 对于组合框, 如果没有选择的项目, 则获取控件编辑区域的文本. 对于多选列表框, 输出结果中使用窗口的当前分隔符.

ListView 和 TreeView: 当 SubCommand 为空时不支持它们. 作为替代, 请使用内置的 ListView 函数和 TreeView 函数.

StatusBar: 仅获取首个部分的文本.

ActiveX: 获取控件的 ActiveX 组件的新包装器对象.

注意: 要无条件检索 CheckBox, Radio, DropDownList 或 ComboBox 控件的文本/标题, 而不是其内容, 请将 Value 指定为单词 Text.

### Pos

检索控件的位置和大小.

    GuiControlGet, OutputVar, Pos , ControlID

这里的位置相对于 GUI 窗口的工作区, 不包括窗口的标题栏, 菜单栏和边框的区域. 信息保存在四个名称以 OutputVar 开始的变量中. 例如:

    GuiControlGet, MyEdit, Pos
    MsgBox The X coordinate is %MyEditX%. The Y coordinate is %MyEditY%. The width is %MyEditW%. The height is %MyEditH%.

在函数中, 要创建一组全局变量而不是局部变量, 请在此命令前声明 OutputVar 为全局变量(对于假设全局函数, 反之亦成). 但是, 通常需要对每个变量都进行声明, 因为可能会造成混乱的根源.

### Focus

检索当前含键盘焦点的控件的标识符(ClassNN).

    GuiControlGet, OutputVar, Focus , ControlID

由于指定的 GUI 窗口必须是活动的, 这样其中的某个控件才会含有焦点, 所以如果窗口不是活动的 OutputVar 将会置空. 用法示例: `GuiControlGet, focused_control, Focus`.

### FocusV [v1.0.43.06+]

检索焦点控件的关联变量的名称.

    GuiControlGet, OutputVar, FocusV , ControlID

为了解详情, 请参阅上面的 Focus 子命令. 如果那个控件没有关联变量, 则获取控件的文本/标题中前 63 个字符(这常用来避免给每个按钮分配变量名).

### Enabled

如果控件是启用的检索 1, 或者如果是禁用的检索 0.

    GuiControlGet, OutputVar, Enabled , ControlID

### Visible

如果控件是可见的检索 1, 或者如果是隐藏的检索 0.

    GuiControlGet, OutputVar, Visible , ControlID

### Hwnd [v1.0.46.16+]

检索控件的窗口句柄(HWND).

    GuiControlGet, OutputVar, Hwnd , ControlID

控件的 HWND 常用于 PostMessage, SendMessage 和 DllCall(). 注: HwndOutputVar 通常是获取 HWND 的一种较简便的方法.

### Name [v1.1.03+]

检索控件的关联变量.

    GuiControlGet, OutputVar, Name , ControlID

如果控件没有关联变量, OutputVar 将会置空.

## 错误处理

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

如果指定的窗口/控件不存在或由于其他问题使得命令无法工作, ErrorLevel 设为 1. 否则, 设为 0.

## 备注

要对非默认窗口进行操作(请参阅下面), 需要在子命令前加上窗口名称或编号和一个冒号, 例如:

    GuiControlGet, MyEdit, MyGui:
    GuiControlGet, MyEdit, MyGui:Pos
    GuiControlGet, OutputVar, MyGui:Focus

这是必须的, 即使 ControlID 是控件的关联变量, 因为变量可用于多个 GUI 窗体. [v1.1.20+] 开始, 当 ControlID 为控件的 HWND 时 GUI 名称可以省略.

GUI 线程是由 GUI 动作启动的. GUI 动作包含从 GUI 窗口的菜单栏选择一个项目或触发其某个 g-标签(例如按下按钮).

GUI 线程的默认窗口名称是运行此线程的窗口名称. 非 GUI 线程的默认窗口编号为 1.

## 相关

Gui, GuiControl, ControlGet

## 示例

检索一个编辑控件的文本并将其存储在 MyEdit.

    GuiControlGet, MyEdit

同上, 但将文本存储在 CtrlContents.

    GuiControlGet, CtrlContents,, MyEdit

如果复选框为选中的则获取的值为 1, 未选中则为 0.

    GuiControlGet, MyCheckbox1

获取复选框的标题/文本.

    GuiControlGet, MyCheckbox1,,, Text

位置/大小会保存到 PicX, PicY, PicW 和 PicH.

    GuiControlGet, Pic, Pos, Static4

dftg