文档控件类型
本主题提供有关 Microsoft UI 自动化对 文档 控件类型的支持的信息。
文档控件允许用户查看和作多页文本。 与仅支持简单格式文本行的编辑控件不同,文档控件可以承载格式丰富且格式丰富的文本
以下部分定义 文档 控件类型所需的 UI 自动化树结构、属性、控件模式和事件。 UI 自动化要求适用于 UI 框架/平台集成 UI 自动化对控件类型和控件模式的支持的所有文档控件。
本主题包含以下部分。
典型树结构
下表描述了与文档控件相关的 UI 自动化树的典型控件和内容视图,并描述了每个视图中可包含的内容。 有关 UI 自动化树的详细信息,请参阅 UI 自动化树概述。
控件视图 | 内容视图 |
---|---|
|
|
相关属性
下表列出了其值或定义与文档控件特别相关的 UI 自动化属性。 有关 UI 自动化属性的详细信息,请参阅 从 UI 自动化元素检索属性。
UI 自动化属性 | 价值 | 笔记 |
---|---|---|
UIA_AutomationIdPropertyId | 请参阅备注。 | 此属性的值在 UI 自动化树的原始视图中的所有对等元素中必须是唯一的。 |
UIA_BoundingRectanglePropertyId | 请参阅备注。 | 包含整个控件的最外侧矩形。 |
UIA_ClickablePointPropertyId | 请参阅备注。 | 文档具有可单击点,该点将导致文档容器中某个元素的文档具有焦点。 |
UIA_ControlTypePropertyId | 文档 | |
UIA_IsContentElementPropertyId | 真 | 文档控件始终包含在 UI 自动化树的内容视图中。 |
UIA_IsControlElementPropertyId | 真 | 文档控件始终包含在 UI 自动化树的控件视图中。 |
UIA_IsKeyboardFocusablePropertyId | 请参阅备注。 | 如果控件可以接收键盘焦点,它必须支持此属性。 |
UIA_LabeledByPropertyId | 请参阅备注。 | 此属性的值应为文档控件的标签。 通常,使用文档的标题。 |
UIA_LocalizedControlTypePropertyId | 请参阅备注。 | 对应于 文档 控件类型的本地化字符串。 en-US 或英语(美国)的默认值为“document”。 |
UIA_NamePropertyId | 请参阅备注。 | 文档控件通常从加载它的文件名中获取其名称。 这通常显示在包含的窗口或框架标题中。 |
所需的控件模式
下表列出了文档控件支持所需的 UI 自动化控件模式。 有关控件模式的详细信息,请参阅 UI 自动化控件模式概述。
控件模式/模式属性 | 支持/值 | 笔记 |
---|---|---|
IScrollProvider | 取决于 | 文档控件可以跨越大于视区跨度。 如果内容可滚动,控件应支持 Scroll 控件模式。 |
ITextProvider | 必填 | 所有文档控件都必须支持 文本 控件模式。 |
IValueProvider | 取决于 | 虽然 UI 自动化客户端可以使用 IUIAutomationTextPattern 获取文档的文本信息,但它们需要 值 控件模式来设置内部值。 简单文本输入只能通过值控件模式进行。 |
必需事件
下表列出了文档控件需要支持的 UI 自动化事件。 有关事件的详细信息,请参阅 UI 自动化事件概述。
UI 自动化事件 | 笔记 |
---|---|
UIA_AutomationFocusChangedEventId | |
UIA_BoundingRectanglePropertyId 属性更改事件。 | |
UIA_IsEnabledPropertyId 属性更改事件。 | 如果控件支持 IsEnabled 属性,则必须支持此事件。 |
UIA_IsOffscreenPropertyId 属性更改事件。 | 如果控件支持 IsOffscreen 属性,则必须支持此事件。 |
UIA_StructureChangedEventId | |
UIA_ScrollHorizontallyScrollablePropertyId 属性更改事件。 | 如果控件支持 Scroll 控件模式,则必须支持此事件。 |
UIA_ScrollHorizontalScrollPercentPropertyId 属性更改事件。 | 如果控件支持 Scroll 控件模式,则必须支持此事件。 |
UIA_ScrollHorizontalViewSizePropertyId 属性更改事件。 | 如果控件支持 Scroll 控件模式,则必须支持此事件。 |
UIA_ScrollVerticallyScrollablePropertyId 属性更改事件。 | 如果控件支持 Scroll 控件模式,则必须支持此事件。 |
UIA_ScrollVerticalScrollPercentPropertyId 属性更改事件。 | 如果控件支持 Scroll 控件模式,则必须支持此事件。 |
UIA_ScrollVerticalViewSizePropertyId 属性更改事件。 | 如果控件支持 Scroll 控件模式,则必须支持此事件。 |
UIA_Selection_InvalidatedEventId | 如果控件支持 选择 控件模式,则必须支持此事件。 |
UIA_Text_TextSelectionChangedEventId | |
UIA_Text_TextChangedEventId | |
UIA_ValueValuePropertyId 属性更改事件。 | 如果控件支持 值 控件模式,则它必须支持此事件。 |
相关主题