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 值提供等效的纯代码支持，而不是使用 Name 附加属性在 XAML 中设置它。 或者，可以使用依赖属性系统来获取或设置附加属性的值，这还会向 Microsoft UI 自动化报告基础值。 调用 GetValue 或 SetValue，传递要设置的依赖属性标识符的参数，以及对其获取或设置值的目标对象的引用。
Name 属性
在各种附加属性中，最重要的属性可能是 Name。 这是因为当用户在辅助功能方案中与应用交互时，由辅助技术最常访问和报告的 Name 属性。 Name 充当 UI 元素的可读标识符。
各种 UI 元素具有对等转发，可根据其他元素属性提供默认 的 Name 值。 例如，Button 类的对等转发将转发 Button 内容的 ToString 计算，并使用此字符串作为默认名称。 若要替代该默认值，或者为没有 Microsoft UI 自动化名称可用的任何 UI 元素提供 Name 值，请在 XAML 中设置该元素的 Name 附加属性。 有关 Microsoft UI 自动化 名称 为何重要的详细信息，请参阅 基本辅助功能信息。 有关如何测试元素是否已具有对等提供的有用 名称 的详细信息，请参阅 辅助功能测试。
出于本地化原因，应避免在 XAML 中为 Name 使用硬编码字符串值。 如果在 元素上设置 x：Uid 指令 ，则可以使用 RESW 资源以属性为目标，并为本地化提供不同的值。 对于附加属性，资源标识符表单要求以 XAML 形式对附加属性进行完全限定，包括其命名空间和 using： 前缀。 例如，若要将 x：Uid 指令值为“sendButton”的资源上的 AutomationProperties.Name 附加属性值，RESW 资源中的数据项的名称值为sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name
附加属性
注意
有关每个附加属性的详细信息，请参阅属性的 “标识符”字段的页面。
| 附加属性 | 说明 |
|---|---|
| AcceleratorKey | 获取或设置指定元素的加速键。 |
| AccessibilityView | 获取或设置元素的 Microsoft UI 自动化树视图模式。 |
| AccessKey | 获取或设置指定元素的访问键。
|
| AutomationId | 获取或设置唯一标识 Microsoft UI 自动化元素的字符串。
|
| 环境 | 获取或设置自动化元素 (的区域设置标识符，例如，0x0409“en-US”或英语 (美国) ) 。指定元素的区域性属性的值。 |
| 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 |
获取区域性附加属性的标识符，该属性包含自动化元素的区域设置标识符 (例如，0x0409“en-US”或英语 (美国) ) 。 |
| DescribedByProperty |
获取由附加属性描述的 的标识符，该属性是提供有关自动化元素的详细信息的元素数组。 |
| FlowsFromProperty |
获取 FlowsFrom 附加属性的标识符，该属性是一个自动化元素数组，建议当前自动化元素之前的读取顺序。 |
| FlowsToProperty |
获取 FlowsTo 附加属性的标识符，该属性是自动化元素的数组，建议当前自动化元素之后的读取顺序。 |
| FullDescriptionProperty |
获取完整说明附加属性的标识符，该属性公开包含元素的扩展说明文本的本地化字符串。 |
| HeadingLevelProperty |
获取 HeadingLevel 附加属性的标识符，该属性指示 UI 自动化元素的标题级别。 |
| HelpTextProperty |
标识 AutomationProperties.HelpText 附加属性，该属性是与自动化元素关联的帮助文本字符串。 |
| IsDataValidForFormProperty |
标识布尔依赖属性，该属性指示数据是否对表单有效。 |
| IsDialogProperty |
标识 AutomationProperties.IsDialog 附加属性，该属性是一个布尔值，指示自动化元素是否为对话框窗口。 |
| IsPeripheralProperty |
标识布尔依赖属性，该属性指示自动化元素是否表示外围 UI。 |
| IsRequiredForFormProperty |
标识 AutomationProperties.IsRequiredForForm 附加属性，该属性是一个布尔值，指示是否需要在窗体上填写自动化元素。 |
| ItemStatusProperty |
标识 ItemStatus 附加属性，该属性描述自动化元素项的状态。 |
| ItemTypeProperty |
标识 AutomationProperties.ItemType 附加属性，该属性是描述自动化元素类型的文本字符串。 |
| LabeledByProperty |
标识 AutomationProperties.LabeledBy 附加属性，该属性是包含此元素的文本标签的自动化元素。 |
| LandmarkTypeProperty |
获取陆标类型附加属性的标识符，该属性是与元素关联的 陆标类型标识符 。 |
| LevelProperty |
获取 Level 附加属性的标识符，该属性是与自动化元素关联的从 1 开始的整数。 |
| LiveSettingProperty |
标识 AutomationProperties.LiveSetting 附加属性，该属性由表示实时区域的自动化元素支持。 |
| LocalizedControlTypeProperty |
标识本地化的控件类型依赖属性，该属性是描述自动化元素表示的控件类型的文本字符串。 |
| LocalizedLandmarkTypeProperty |
获取本地化地标类型附加属性的标识符，该属性是描述自动化元素表示的陆标类型的本地化文本字符串。 |
| NameProperty |
标识 AutomationProperties.Name 附加属性，该属性是保存自动化元素名称的字符串。 |
| PositionInSetProperty |
获取 PositionInSet 附加属性的标识符，该属性是与自动化元素关联的从 1 开始的整数。 |
| SizeOfSetProperty |
获取附加属性的标识符。 |
附加属性
| AcceleratorKey |
获取或设置一个字符串，其中包含快捷键 (也称为快捷键) 自动化元素的组合。 |
| AccessibilityView |
获取或设置元素的 Microsoft UI 自动化树视图模式。 |
| AccessKey |
获取或设置包含自动化元素的访问键字符的字符串。 |
| Annotations |
获取文档中批注对象的列表，例如注释、页眉、页脚等。 |
| AutomationControlType |
标识向 Microsoft UI 自动化客户端公开的用户界面 (UI) 元素的类型。 |
| AutomationId |
获取或设置唯一标识 Microsoft UI 自动化元素的字符串。 |
| ControlledPeers |
获取可由指定的自动化元素操作的自动化元素的集合。 |
| Culture |
获取或设置自动化元素 (的区域设置标识符，例如，0x0409“en-US”或英语 (美国) ) 。 |
| 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 |
获取或设置一组被视为同级元素的元素数。 |