文档控件类型

  • 项目

本主题提供有关 Microsoft UI 自动化对 Document 控件类型的支持的信息。

文档控件使用户能够查看和处理多页文本。 与仅支持一行简单无格式文本的编辑控件不同，文档控件可以承载样式丰富且格式设置丰富的文本

以下部分定义 Document 控件类型所需的UI 自动化树结构、属性、控件模式和事件。 UI 自动化要求适用于 UI 框架/平台集成UI 自动化控件类型和控件模式支持的所有文档控件。

本主题包含以下各节：

典型树结构

下表描述了与文档控件相关的UI 自动化树的典型控件和内容视图，并描述了每个视图中可以包含的内容。 有关 UI 自动化树的详细信息，请参阅 UI 自动化树概述。

控件视图 内容视图
  • 文档
    • 多种多样
  • 文档
    • 多种多样

 

相关属性

下表列出了值或定义与文档控件特别相关的 UI 自动化属性。 有关UI 自动化属性的详细信息，请参阅从UI 自动化元素检索属性。

UI 自动化属性 值 说明
UIA_AutomationIdPropertyId 请参阅注释。 此属性的值在UI 自动化树的原始视图中的所有对等元素中必须是唯一的。
UIA_BoundingRectanglePropertyId 请参阅注释。 包含整个控件的最外层矩形。
UIA_ClickablePointPropertyId 请参阅注释。 文档具有一个可单击的点，单击该点将使文档容器中它的其中一个元素的文档获得焦点。
UIA_ControlTypePropertyId Document
UIA_IsContentElementPropertyId TRUE 文档控件始终包含在 UI 自动化树的内容视图中。
UIA_IsControlElementPropertyId TRUE 文档控件始终包含在 UI 自动化树的控件视图中。
UIA_IsKeyboardFocusablePropertyId 请参阅注释。 如果该控件可以接收键盘焦点，则它必须支持此属性。
UIA_LabeledByPropertyId 请参阅注释。 此属性的值应为文档控件的标签。 通常使用文档的标题。
UIA_LocalizedControlTypePropertyId 请参阅注释。 对应于 Document 控件类型的本地化字符串。 en-US 或英语 (美国) 的默认值为“document”。
UIA_NamePropertyId 请参阅注释。 文档控件通常从加载它的文件名中获取其名称。 这通常显示在包含窗口或框架标题中。

 

所需的控件模式

下表列出了需要文档控件支持的 UI 自动化控件模式。 有关控件模式的详细信息，请参阅 UI Automation Control Patterns Overview。

控件模式/模式属性 支持/值 注释
IScrollProvider 依赖的对象 文档控件可以跨越比视区更大的范围。 如果内容可滚动，控件应支持 Scroll 控件模式。
ITextProvider 必选 所有文档控件都必须支持 文本 控件模式。
IValueProvider 依赖的对象 虽然UI 自动化客户端可以使用 IUIAutomationTextPattern 获取有关文档的文本信息，但它们需要 Value 控件模式来设置内部值。 只能通过 Value 控件模式输入简单的文本。

 

必需事件

下表列出了文档控件需要支持的UI 自动化事件。 有关事件的详细信息，请参阅 F:System.Windows.Automation.AutomationElementIdentifiers.IsEnabledProperty。

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 如果控件支持 Selection 控件模式，则它必须支持此事件。
UIA_Text_TextSelectionChangedEventId
UIA_Text_TextChangedEventId
UIA_ValueValuePropertyId 属性更改事件。 如果控件支持 Value 控件模式，则它必须支持此事件。

 

概念性

UI 自动化控件类型概述

UI 自动化概述