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

注意注意

本文档的目标读者是欲使用 System.Windows.Automation 命名空间中定义的托管 UI Automation类的 .NET Framework 开发人员。有关 UI Automation的最新信息,请参见 Windows Automation API: UI Automation(Windows 自动化 API:UI 自动化)。

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

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

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

本主题包括下列各节。

  • 必需的 UI 自动化树结构
  • 必需的 UI 自动化属性
  • 必需的 UI 自动化控件模式
  • 必需的 UI 自动化事件
  • 相关主题

必需的 UI 自动化树结构

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

控件视图

内容视图

文档

  • 可变

文档

  • 可变

必需的 UI 自动化属性

下表列出了值或定义与文档控件密切相关的 UI Automation属性。 有关 UI Automation属性的更多信息,请参见 客户端的 UI 自动化属性

UI Automation属性

注释

AutomationIdProperty

请参见“说明”。

此属性的值在应用程序的所有控件中都必须保持唯一。

BoundingRectangleProperty

请参见“说明”。

包含整个控件的最外面的矩形。

ClickablePointProperty

请参见“说明”。

文档具有一个可单击的点,单击该点将使文档容器中它的其中一个元素的文档获得焦点。

ControlTypeProperty

Document

此值对于所有的 UI 框架均相同。

IsContentElementProperty

True

文档控件始终包括在 UI Automation树的内容视图中。

IsControlElementProperty

True

文档控件始终包括在 UI Automation树的控件视图中。

IsKeyboardFocusableProperty

请参见“说明”。

如果该控件可以接收键盘焦点,则它必须支持此属性。

LabeledByProperty

请参见“说明”。

此属性的值应为文档控件的标签。 通常使用文档的标题。

LocalizedControlTypeProperty

“文档”

与 Document 控件类型相对应的本地化字符串。

NameProperty

请参见“说明”。

文档控件通常从其从中加载的文件名中获取其名称。 这通常显示在包含窗口或框架标题中。

必需的 UI 自动化控件模式

下表列出了必须由文档控件支持的 UI Automation控件模式。 有关控件模式的更多信息,请参见 UI 自动化控件模式概述

控件模式

支持

注释

IScrollProvider

视情况而定

文档控件可以跨越比视区更大的范围。 如果内容是可滚动的,则该控件应支持 Scroll 控件模式。

ITextProvider

必需

文档控件可以跨越比视区更大的范围。 如果内容是可滚动的,则该控件应支持 Scroll 控件模式。

IValueProvider

从不

文档控件不支持此控件模式,原因是控件的内容通常跨越多页。 UI 自动化客户端应使用 TextPattern 来获取有关文档的文本信息。

必需的 UI 自动化事件

下表列出了必须由所有文档控件支持的 UI Automation事件。 有关事件的更多信息,请参见 UI 自动化事件概述

UI Automation事件

支持

注释

AutomationFocusChangedEvent

必需

BoundingRectangleProperty property-changed 事件。

必需

IsEnabledProperty property-changed 事件。

必需

IsOffscreenProperty property-changed 事件。

必需

StructureChangedEvent

必需

HorizontallyScrollableProperty property-changed 事件。

必需

HorizontalScrollPercentProperty property-changed 事件。

必需

HorizontalViewSizeProperty property-changed 事件。

必需

VerticalScrollPercentProperty property-changed 事件。

必需

VerticallyScrollableProperty property-changed 事件。

必需

VerticalViewSizeProperty property-changed 事件。

必需

InvalidatedEvent

视情况而定

如果控件支持 Selection 控件模式,则它必须支持此事件。

TextSelectionChangedEvent

必需

TextChangedEvent

必需

ValueProperty property-changed 事件。

从不

请参见

参考

Document

概念

UI 自动化控件类型概述

UI 自动化概述