UI 自动化对 Document 控件类型的支持

注意

本文档适用于想要使用 System.Windows.Automation 命名空间中定义的托管 UI 自动化类的 .NET Framework 开发人员。 有关 UI 自动化的最新信息,请参阅 Windows 自动化 API:UI 自动化

本主题介绍有关“UI 自动化对 Document 控件类型的支持”的信息。 在 UI 自动化中,控件类型是一组条件,控件必须满足这些条件才能使用 ControlTypeProperty 属性。 这些条件包括针对 UI 自动化树结构、UI 自动化属性值和控件模式的特定准则。

文档控件使用户能够查看和处理多页文本。 与仅支持单行无格式文本的编辑控件不同,文档控件可以托管具有丰富样式和格式的文本。

以下几部分定义 Document 控件类型必需的 UI 自动化树结构、属性、控件模式和事件。 UI 自动化要求适用于所有文档控件,无论是 Windows Presentation Foundation (WPF)、Win32 还是 Windows 窗体。

必需的 UI 自动化树结构

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

控件视图 内容视图
文档

- 不定
文档

- 不定

必需的 UI 自动化属性

下表列出了值或定义与文档控件特别相关的 UI 自动化属性。 有关 UI 自动化属性的详细信息,请参阅客户端的 UI 自动化属性

UI 自动化属性 说明
AutomationIdProperty 请参阅注释。 此属性的值在应用程序的所有控件中都必须保持唯一。
BoundingRectangleProperty 请参阅注释。 包含整个控件的最外层矩形。
ClickablePointProperty 请参阅注释。 文档具有一个可单击的点,单击该点将使文档容器中它的其中一个元素的文档获得焦点。
ControlTypeProperty 文档 此值对于所有 UI 框架均相同。
IsContentElementProperty 正确 文档控件始终包含在 UI 自动化树的内容视图中。
IsControlElementProperty 正确 文档控件始终包含在 UI 自动化树的控件视图中。
IsKeyboardFocusableProperty 请参阅注释。 如果该控件可以接收键盘焦点,则它必须支持此属性。
LabeledByProperty 请参阅注释。 此属性的值应为文档控件的标签。 通常使用文档的标题。
LocalizedControlTypeProperty “文档” 与 Document 控件类型相对应的本地化字符串。
NameProperty 请参阅注释。 文档控件通常从加载它的文件名称中获取其名称。 这通常显示在包含窗口或框架标题中。

必需的 UI 自动化控件模式

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

控件模式 支持 说明
IScrollProvider 依赖的对象 文档控件可以跨越比视区更大的范围。 如果内容是可滚动的,则控件应支持 Scroll 控件模式。
ITextProvider 必需 文档控件可以跨越比视区更大的范围。 如果内容是可滚动的,则控件应支持 Scroll 控件模式。
IValueProvider 从不 文档控件不支持此控件模式,因为控件的内容通常跨越多页。 UI 自动化客户端应使用 TextPattern 来获取有关文档的文本信息。

必需的 UI 自动化事件

下表列出了需要所有文档控件支持的 UI 自动化事件。 有关事件的详细信息,请参阅 UI Automation Events Overview

UI 自动化事件 支持 说明
AutomationFocusChangedEvent 必须
BoundingRectangleProperty 属性更改事件。 必需
IsEnabledProperty 属性更改事件。 必需
IsOffscreenProperty 属性更改事件。 必需
StructureChangedEvent 必须
HorizontallyScrollableProperty 属性更改事件。 必需
HorizontalScrollPercentProperty 属性更改事件。 必需
HorizontalViewSizeProperty 属性更改事件。 必需
VerticalScrollPercentProperty 属性更改事件。 必需
VerticallyScrollableProperty 属性更改事件。 必需
VerticalViewSizeProperty 属性更改事件。 必需
InvalidatedEvent 依赖的对象 如果控件支持 Selection 控件模式,则它必须支持此事件。
TextSelectionChangedEvent 必需
TextChangedEvent 必须
ValueProperty 属性更改事件。 从不

请参阅