AutomationProperties 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
支持获取或设置自动化属性的实例级值。 这些属性值设置为附加属性（通常在 XAML 中），并补充或替代控件 AutomationPeer中的自动化属性值。
public ref class AutomationProperties sealed/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AutomationProperties final[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AutomationPropertiesPublic NotInheritable Class AutomationProperties- 继承
- 属性
注解
XAML 附加属性
AutomationProperties 是多个 XAML 附加属性的主机服务类。 这些附加属性的目的是启用设置与 UI 元素如何报告到 Microsoft UI 自动化辅助功能框架相关的各种每个实例值。 如果 UI 元素的类设计尚未将其他与 UI 相关的属性值转发为其Microsoft UI 自动化集成或对等实现行为的一部分，或者转发的值不是要报告给Microsoft UI 自动化的值，则此方法非常有用。
为了支持对附加属性的 XAML 处理器访问，并公开对代码的等效 get 和 set 操作，每个 XAML 附加属性都有一对 Get 和 Set 访问器方法，这些方法也是 AutomationProperties 的成员。 例如，GetName 和 SetName 方法支持，并提供对报告自动化 名称 值的等效代码支持，以Microsoft UI 自动化，而不是使用 Name 附加属性在 XAML 中设置它。 或者，可以使用依赖属性系统来获取或设置附加属性的值，这也会将基础值报告为Microsoft UI 自动化。 调用 GetValue 或 SetValue，传递要设置的依赖属性标识符的参数，以及对其获取或设置值的目标对象的引用。
Name 属性
在各种附加属性中，可能是最重要的属性是 名称。 这是因为，当用户在辅助功能方案中与应用交互时，该属性 Name 属性最常被辅助技术访问和报告。 名称 充当 UI 元素的可读标识符。
各种 UI 元素具有对等转发，可以根据其他元素属性提供默认 名称 值。 例如，Button 类的对等转发将转发 Button 内容的 ToString 评估，并将此字符串用作默认 名称。 若要重写该默认值，或者为任何 UI 元素提供 Name 值（如果不存在Microsoft UI 自动化 名称 可用），请设置 XAML 中该元素上的 Name 附加属性。 若要详细了解为什么Microsoft UI 自动化 名称 很重要，请参阅 基本辅助功能信息。 有关如何测试元素是否已具有有用的对等 名称 的详细信息，请参阅 辅助功能测试。
出于本地化原因，应避免 XAML 中 名称 的硬编码字符串值。 如果在元素上设置了 x：Uid 指令，则可以使用 RESW 资源定位属性并提供不同的本地化值。 对于附加属性，资源标识符表单需要 XAML 格式附加属性的完整限定，包括其命名空间和 using： 前缀。 例如，若要针对 x：Uid 指令 值为“sendButton”的资源 AutomationProperties.Name 附加属性值，RESW 资源中 数据 项 名称 值 sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name
附加属性
注意
有关每个附加属性的详细信息，请参阅属性 标识符字段的页面。
| Attached 属性 | 描述 |
|---|---|
| AcceleratorKey | 获取或设置指定元素的快捷键。 |
| AccessibilityView | 获取或设置元素的Microsoft UI 自动化树视图模式。 |
| AccessKey | 获取或设置指定元素的访问键。 |
| AutomationId | 获取或设置唯一标识要Microsoft UI 自动化的元素的字符串。 |
| 文化 | 获取或设置自动化元素的区域设置标识符（例如，“en-US”或英语（美国）的0x0409）。指定元素的区域性属性的值。 |
| FullDescription | 获取或设置包含元素的扩展说明文本的本地化字符串。 |
| HeadingLevel | 获取或设置 UI 自动化元素的标题级别。 |
| HelpText | 获取或设置元素的帮助文本。 |
| IsDataValidForForm | 获取或设置一个值，该值指示数据是否对窗体有效。 |
| IsDialog | 获取或设置一个值，该值指示自动化元素是否为对话框窗口。 |
| IsPeripheral | 获取或设置一个值，该值指示自动化元素是否表示外围 UI。 |
| IsRequiredForForm | 获取或设置一个值，该值指示是否需要在窗体上填写元素。 |
| ItemStatus | 获取或设置元素中项状态的说明。 |
| ItemType | 获取或设置指定元素类型的说明。 |
| LabeledBy | 获取或设置包含元素的文本标签的元素。 |
| LandmarkType | 获取或设置与元素关联的 特征点类型标识符。 |
| 水平 | 获取或设置一个基于 1 的整数，该整数描述分层或损坏层次结构中元素的位置。 |
| LiveSetting | 获取或设置指定元素的实时设置值。 |
| LocalizedControlType | 获取或设置一个本地化的文本字符串，该字符串描述自动化元素所表示的控件的类型。 |
| LocalizedLandmarkType | 获取或设置一个本地化的文本字符串，该字符串描述自动化元素所表示的地标类型。 |
| 名字 | 获取或设置元素的 UI 自动化名称。 |
| PositionInSet | 获取或设置一个基于 1 的整数，该整数描述一组被视为同级元素的元素中的序号位置。 |
| SizeOfSet | 获取或设置一组被视为同级元素的元素数。 |
属性
| AcceleratorKeyProperty |
标识 AutomationProperties.AcceleratorKey 附加属性，该属性是包含自动化元素的快捷键（也称为快捷键）组合的字符串。 |
| AccessibilityViewProperty |
标识 AutomationProperties.AccessibilityView 附加属性。 在各个元素上设置此附加属性，以便将其元素可见性更改为 UI 自动化客户端请求的特定模式。 |
| AccessKeyProperty |
标识 AutomationProperties.AccessKey 附加属性，该属性是包含自动化元素的访问键字符的字符串。 |
| AnnotationsProperty |
标识用于文档中批注对象的列表的依赖属性，例如注释、页眉、页脚等。 |
| AutomationControlTypeProperty |
标识 AutomationProperties 附加属性，该属性是 Microsoft.UI.Xaml.Automation.Peers.AutomationControlType。 |
| AutomationIdProperty |
标识 AutomationProperties.AutomationId 附加属性，该属性是包含自动化元素的 UI 自动化标识符（ID）的字符串。 |
| ControlledPeersProperty |
标识 ControledPeers 附加属性，该属性用于可由指定自动化元素操作的自动化元素集合。 |
| CultureProperty |
获取区域性附加属性的标识符，该属性包含自动化元素的区域设置标识符（例如，“en-US”或英语（美国）的0x0409）。 |
| DescribedByProperty |
获取附加属性描述的标识符，该标识符是一组元素，提供有关自动化元素的详细信息。 |
| FlowsFromProperty |
获取 FlowFrom 附加属性的标识符，该属性是一组自动化元素，它建议当前自动化元素之前的读取顺序。 |
| FlowsToProperty |
获取 FlowTo 附加属性的标识符，该属性是一组自动化元素，它建议当前自动化元素之后的读取顺序。 |
| FullDescriptionProperty |
获取完整说明附加属性的标识符，该属性公开包含元素的扩展说明文本的本地化字符串。 |
| HeadingLevelProperty |
获取 HeadingLevel 附加属性的标识符，该属性指示 UI 自动化元素的标题级别。 |
| HelpTextProperty |
标识 AutomationProperties.HelpText attached 属性，该属性是与自动化元素关联的帮助文本字符串。 |
| IsDataValidForFormProperty |
标识布尔依赖项属性，该属性指示数据是否对表单有效。 |
| IsDialogProperty |
标识 AutomationProperties.IsDialog 附加属性，该属性是一个布尔值，指示自动化元素是否为对话框窗口。 |
| IsPeripheralProperty |
标识指示自动化元素是否表示外围 UI 的布尔依赖项属性。 |
| IsRequiredForFormProperty |
标识 AutomationProperties.IsRequiredForForm 附加属性，该属性是一个布尔值，指示是否需要在窗体上填写自动化元素。 |
| ItemStatusProperty |
标识 ItemStatus 附加属性，该属性描述自动化元素项的状态。 |
| ItemTypeProperty |
标识 AutomationProperties.ItemType 附加属性，该属性是描述自动化元素类型的文本字符串。 |
| LabeledByProperty |
标识 AutomationProperties.LabeledBy 附加属性，该属性是包含此元素的文本标签的自动化元素。 |
| LandmarkTypeProperty |
获取特征点类型附加属性的标识符，该属性是与元素关联的 特征点类型标识符。 |
| LevelProperty |
获取 级别 附加属性的标识符，该属性是与自动化元素关联的基于 1 的整数。 |
| LiveSettingProperty |
标识 AutomationProperties.LiveSetting 附加属性，该属性由表示实时区域的自动化元素支持。 |
| LocalizedControlTypeProperty |
标识本地化的控件类型依赖属性，该属性是描述自动化元素所表示控件类型的文本字符串。 |
| LocalizedLandmarkTypeProperty |
获取本地化特征点类型附加属性的标识符，该属性是描述自动化元素所表示的地标类型的本地化文本字符串。 |
| NameProperty |
标识 AutomationProperties.Name 附加属性，该属性是保存自动化元素名称的字符串。 |
| PositionInSetProperty |
获取 PositionInSet attached 属性的标识符，该属性是与自动化元素关联的基于 1 的整数。 |
| SizeOfSetProperty |
获取附加属性的标识符。 |
附加属性
| AcceleratorKey |
获取或设置一个字符串，其中包含自动化元素的快捷键（也称为快捷键）组合。 |
| AccessibilityView |
获取或设置元素的Microsoft UI 自动化树视图模式。 |
| AccessKey |
获取或设置一个字符串，其中包含自动化元素的访问键字符。 |
| Annotations |
获取文档中批注对象的列表，例如注释、页眉、页脚等。 |
| AutomationControlType |
标识向 Microsoft UI 自动化客户端公开的用户界面 （UI） 元素的类型。 |
| AutomationId |
获取或设置唯一标识要Microsoft UI 自动化的元素的字符串。 |
| ControlledPeers |
获取可由指定自动化元素操作的自动化元素的集合。 |
| Culture |
获取或设置自动化元素的区域设置标识符（例如，“en-US”或英语（美国）的0x0409）。 |
| DescribedBy |
获取一个元素数组，这些元素提供有关自动化元素的详细信息。 |
| FlowsFrom |
获取一个自动化元素数组，该数组建议当前自动化元素之前的读取顺序。 |
| FlowsTo |
获取一个自动化元素数组，该数组建议当前自动化元素之后的读取顺序。 |
| FullDescription |
获取或设置包含元素的扩展说明文本的本地化字符串。 |
| HeadingLevel |
获取或设置 UI 自动化元素的标题级别。 |
| HelpText |
获取或设置与自动化元素关联的帮助文本字符串。 |
| IsDataValidForForm |
获取或设置一个值，该值指示数据是否对窗体有效。 |
| IsDialog |
获取或设置一个值，该值指示自动化元素是否为对话框窗口。 |
| IsPeripheral |
获取或设置一个值，该值指示自动化元素是否表示外围 UI。 |
| IsRequiredForForm |
获取或设置一个值，该值指示是否需要在窗体上填写元素。 |
| ItemStatus |
获取或设置元素中项状态的说明。 |
| ItemType |
获取或设置指定元素类型的说明。 |
| LabeledBy |
获取或设置包含此元素的文本标签的自动化元素。 |
| LandmarkType |
获取或设置与元素关联的 特征点类型标识符。 |
| Level |
获取或设置一个基于 1 的整数，该整数描述分层或损坏层次结构中元素的位置。 |
| LiveSetting |
获取或设置表示实时区域的自动化元素支持的指定元素的实时设置值。 |
| LocalizedControlType |
获取或设置一个本地化的文本字符串，该字符串描述自动化元素所表示的控件的类型。 |
| LocalizedLandmarkType |
获取或设置一个本地化的文本字符串，该字符串描述自动化元素所表示的地标类型。 |
| Name |
获取或设置元素的 UI 自动化名称。 |
| PositionInSet |
获取或设置一个基于 1 的整数，该整数描述一组被视为同级元素的元素中的序号位置。 |
| SizeOfSet |
获取或设置一组被视为同级元素的元素数。 |