AutomationProperties Класс

  • Ссылка

Определение

Пространство имен:
Microsoft.UI.Xaml.Automation
Изменить

Обеспечивает поддержку получения или задания значений на уровне экземпляра свойств автоматизации. Эти значения свойств задаются как присоединенные свойства (обычно в 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 AutomationProperties
Public NotInheritable Class AutomationProperties
Наследование
Object Platform::Object IInspectable AutomationProperties
Атрибуты
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Комментарии

Присоединенные свойства XAML

AutomationProperties — это класс службы узла для нескольких присоединенных свойств XAML. Цель этих присоединенных свойств — включить настройку различных значений для каждого экземпляра, которые относятся к тому, как элемент пользовательского интерфейса передается в платформу специальных возможностей автоматизации пользовательского интерфейса Майкрософт. Это полезно в случаях, когда макет класса элемента пользовательского интерфейса еще не пересылает другие значения свойств, связанных с пользовательским интерфейсом, в рамках интеграции с автоматизацией пользовательского интерфейса Майкрософт или поведением реализации однорангового узла или когда пересылаемое значение не является значением, которое вы хотите сообщить в службу автоматизации пользовательского интерфейса Майкрософт.

Для поддержки доступа обработчика XAML к присоединенным свойствам, а также для предоставления эквивалентных операций получения и задания в коде каждое присоединенное свойство XAML имеет пару методов доступа Get и Set , которые также являются членами AutomationProperties. Например, методы GetName и SetName поддерживают и обеспечивают эквивалентную поддержку только кода для отправки значений имен автоматизации в автоматизацию пользовательского интерфейса Майкрософт вместо использования присоединенного свойства Name для задания его в XAML. Кроме того, можно использовать систему свойств зависимостей, чтобы получить или задать значение присоединенного свойства, а также сообщить базовое значение в службу автоматизации пользовательского интерфейса Майкрософт. Вызовите метод GetValue или SetValue, передав аргументы заданного идентификатора свойства зависимостей и ссылку на целевой объект, для которого требуется получить или задать значение.

Name - свойство

Из различных присоединенных свойств, вероятно, наиболее важным является Имя. Это связано с тем, что это свойство Name , к которому чаще всего обращаются специальные возможности, когда пользователи взаимодействуют с приложением в сценарии специальных возможностей. Имя служит в качестве удобочитаемого идентификатора для элемента пользовательского интерфейса.

Различные элементы пользовательского интерфейса имеют одноранговую пересылку, которая может предоставлять значение name по умолчанию на основе других свойств элементов. Например, одноранговая пересылка для класса Button будет пересылать оценку ToString содержимого Button и использовать эту строку в качестве имени по умолчанию. Чтобы переопределить это значение по умолчанию или иным образом предоставить значение Name для любого случая элемента пользовательского интерфейса, в котором отсутствует доступное имя модели автоматизации пользовательского интерфейса Майкрософт, задайте свойство Name attached для этого элемента в XAML. Дополнительные сведения о том, почему имя автоматизации пользовательского интерфейса Майкрософт важно, см. в статье Основные сведения о специальных возможностях. Дополнительные сведения о том, как проверить, имеет ли элемент уже полезное одноранговое имя , см. в разделе Проверка читаемости.

В целях локализации следует избегать жестко заданных строковых значений для name в XAML. Если для элемента задана директива x:Uid , можно использовать ресурсы RESW для назначения свойства и предоставления различных значений для локализации. Для вложенных свойств форма идентификатора ресурса требует полной квалификации присоединенного свойства в форме XAML, включая его пространство имен и префикс using: . Например, чтобы нацелить AutomationProperties.Name значение присоединенного свойства для ресурса со значением директивы x:Uid "sendButton", значение имени элемента данных в ресурсах RESW будет равно sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name

Присоединенные свойства

Примечание

Дополнительные сведения о каждом присоединенном свойстве см. на странице поля Идентификатор свойства.

Присоединенное свойство Описание
AcceleratorKey Получает или задает сочетание клавиш для указанного элемента.
AccessibilityView Возвращает или задает режим представления дерева модели автоматизации пользовательского интерфейса Майкрософт для элемента.
AccessKey Получает или задает клавишу доступа для указанного элемента.
AutomationId Возвращает или задает строку, которая однозначно идентифицирует элемент для модели автоматизации пользовательского интерфейса Майкрософт.
Культура Возвращает или задает идентификатор языкового стандарта для элемента автоматизации (например, 0x0409 для en-US или английского языка (США)).Значение свойства языка и региональных параметров для указанного элемента.
Полное описание Возвращает или задает локализованную строку, содержащую расширенный текст описания для элемента.
ЗаголовокLevel Возвращает или задает уровень заголовка для элемента автоматизации пользовательского интерфейса.
HelpText Возвращает или задает текст справки для элемента .
IsDataValidForForm Возвращает или задает значение, указывающее, являются ли данные допустимыми для формы.
IsDialog Возвращает или задает значение, указывающее, является ли элемент автоматизации диалоговым окном.
IsPeripheral Возвращает или задает значение, указывающее, представляет ли элемент автоматизации периферийный пользовательский интерфейс.
IsRequiredForForm Возвращает или задает значение, указывающее, требуется ли заполнение элемента в форме.
ItemStatus Возвращает или задает описание состояния элемента в элементе .
ItemType Возвращает или задает описание типа определенного элемента.
LabeledBy Возвращает или задает элемент, содержащий текстовую метку для элемента .
LandmarkType Возвращает или задает идентификатор типа ориентира , связанный с элементом.
Level Возвращает или задает целое число из 1, описывающее расположение элемента внутри иерархических или неработающих иерархических структур.
LiveSetting Возвращает или задает динамическое значение параметра для указанного элемента.
LocalizedControlType Возвращает или задает локализованную текстовую строку, описывающую тип элемента управления, представляемого элементом автоматизации.
LocalizedLandmarkType Возвращает или задает локализованную текстовую строку, описывающую тип ориентира, представляемого элементом автоматизации.
Имя Возвращает или задает имя элемента автоматизации пользовательского интерфейса.
PositionInSet Возвращает или задает целое число из 1, описывающее порядковый номер элемента в наборе элементов, которые считаются одноуровневые.
SizeOfSet Возвращает или задает количество элементов в наборе элементов, которые считаются одноуровневые элементы.

Свойства

AcceleratorKeyProperty

Определяет присоединенное свойство AutomationProperties.AcceleratorKey , которое представляет собой строку, содержащую сочетания клавиш ускорителя (также называемые сочетанием клавиш) для элемента автоматизации.
AccessibilityViewProperty

Определяет присоединенное свойство AutomationProperties.AccessibilityView . Задайте это присоединенное свойство для отдельных элементов, чтобы изменить видимость их элементов на определенные режимы, запрашиваемые клиентом автоматизации пользовательского интерфейса.
AccessKeyProperty

Определяет присоединенное свойство AutomationProperties.AccessKey , которое представляет собой строку, содержащую символ ключа доступа для элемента автоматизации.
AnnotationsProperty

Определяет свойство зависимостей, используемое для списка объектов заметки в документе, таких как комментарий, верхний колонтитул, нижний колонтитул и т. д.
AutomationControlTypeProperty

Идентифицирует присоединенное AutomationProperties свойство , которое является .Microsoft.UI.Xaml.Automation.Peers.AutomationControlType
AutomationIdProperty

Идентифицирует присоединенное свойство AutomationProperties.AutomationId , которое представляет собой строку, содержащую идентификатор автоматизации пользовательского интерфейса для элемента автоматизации.
ControlledPeersProperty

Определяет присоединенное свойство ControlledPeers, которое используется для коллекции элементов автоматизации, которыми может управлять указанный элемент автоматизации.
CultureProperty

Возвращает идентификатор присоединенного свойства языка и региональных параметров, содержащего идентификатор языкового стандарта для элемента автоматизации (например, 0x0409 для en-US или английского языка (США)).
DescribedByProperty

Возвращает идентификатор объекта , описываемого присоединенным свойством , который представляет собой массив элементов, предоставляющих дополнительные сведения об элементе автоматизации.
FlowsFromProperty

Возвращает идентификатор присоединенного свойства FlowsFrom , представляющее собой массив элементов автоматизации, который предлагает порядок чтения перед текущим элементом автоматизации.
FlowsToProperty

Возвращает идентификатор присоединенного свойства FlowsTo , которое представляет собой массив элементов автоматизации, который предлагает порядок чтения после текущего элемента автоматизации.
FullDescriptionProperty

Возвращает идентификатор присоединенного свойства полного описания, которое предоставляет локализованную строку, содержащую расширенный текст описания для элемента.
HeadingLevelProperty

Возвращает идентификатор присоединенного свойства HeadingLevel , указывающего уровень заголовка для элемента автоматизации пользовательского интерфейса.
HelpTextProperty

Определяет присоединенное свойство AutomationProperties.HelpText , которое представляет собой текстовую строку справки, связанную с элементом автоматизации.
IsDataValidForFormProperty

Идентифицирует свойство логической зависимости, указывающее, допустимы ли данные для формы.
IsDialogProperty

Определяет присоединенное свойство AutomationProperties.IsDialog , представляющее собой логическое значение, указывающее, является ли элемент автоматизации диалоговым окном.
IsPeripheralProperty

Определяет логическое свойство зависимости, указывающее, представляет ли элемент автоматизации периферийный пользовательский интерфейс.
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

Возвращает или задает режим представления дерева модели автоматизации пользовательского интерфейса Майкрософт для элемента.
AccessKey

Возвращает или задает строку, содержащую символ ключа доступа для элемента автоматизации.
Annotations

Возвращает список объектов заметки в документе, таких как комментарий, верхний колонтитул, нижний колонтитул и т. д.
AutomationControlType

Определяет тип элемента пользовательского интерфейса, который предоставляется клиенту автоматизации пользовательского интерфейса Майкрософт.
AutomationId

Возвращает или задает строку, которая однозначно идентифицирует элемент для модели автоматизации пользовательского интерфейса Майкрософт.
ControlledPeers

Возвращает коллекцию элементов автоматизации, которыми можно управлять с помощью указанного элемента автоматизации.
Culture

Возвращает или задает идентификатор языкового стандарта для элемента автоматизации (например, 0x0409 для en-US или английского языка (США)).
DescribedBy

Возвращает массив элементов, предоставляющих дополнительные сведения об элементе автоматизации.
FlowsFrom

Возвращает массив элементов автоматизации, который предлагает порядок чтения перед текущим элементом автоматизации.
FlowsTo

Возвращает массив элементов автоматизации, который предлагает порядок чтения после текущего элемента автоматизации.
FullDescription

Возвращает или задает локализованную строку, содержащую расширенный текст описания для элемента.
HeadingLevel

Возвращает или задает уровень заголовка для элемента автоматизации пользовательского интерфейса.
HelpText

Возвращает или задает текстовую строку справки, связанную с элементом автоматизации.
IsDataValidForForm

Возвращает или задает значение, указывающее, являются ли данные допустимыми для формы.
IsDialog

Возвращает или задает значение, указывающее, является ли элемент автоматизации диалоговым окном.
IsPeripheral

Возвращает или задает значение, указывающее, представляет ли элемент автоматизации периферийный пользовательский интерфейс.
IsRequiredForForm

Возвращает или задает значение, указывающее, требуется ли заполнение элемента в форме.
ItemStatus

Возвращает или задает описание состояния элемента в элементе .
ItemType

Возвращает или задает описание типа определенного элемента.
LabeledBy

Возвращает или задает элемент автоматизации, содержащий текстовую метку для этого элемента.
LandmarkType

Возвращает или задает идентификатор типа ориентира , связанный с элементом.
Level

Возвращает или задает целое число на основе 1, описывающее расположение элемента внутри иерархических или неработающих иерархических структур.
LiveSetting

Возвращает или задает значение динамического параметра для указанного элемента, которое поддерживается элементом автоматизации, представляющим динамическую область.
LocalizedControlType

Возвращает или задает локализованную текстовую строку, описывающую тип элемента управления, который представляет элемент автоматизации.
LocalizedLandmarkType

Возвращает или задает локализованную текстовую строку, описывающую тип ориентира, который представляет элемент автоматизации.
Name

Возвращает или задает имя элемента в модели автоматизации пользовательского интерфейса.
PositionInSet

Возвращает или задает целое число на основе 1, описывающее порядковый номер элемента в наборе элементов, которые считаются элементами того же уровня.
SizeOfSet

Возвращает или задает количество элементов в наборе элементов, которые считаются элементами того же уровня.

Методы

GetAcceleratorKey(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.AcceleratorKey для указанного Объекта DependencyObject.
GetAccessibilityView(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.AccessibilityView для указанного Объекта DependencyObject.
GetAccessKey(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.AccessKey для указанного Объекта DependencyObject.
GetAnnotations(DependencyObject)

Возвращает значение свойства AutomationProperties.Annotations для указанного Объекта DependencyObject.
GetAutomationControlType(UIElement)

Возвращает для Microsoft.UI.Xaml.Automation.Peers.AutomationControlType указанного элемента пользовательского интерфейса.
GetAutomationId(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.AutomationId для указанного Объекта DependencyObject.
GetControlledPeers(DependencyObject)

Статический служебный метод, который получает список управляемых одноранговых узлов от владельца целевого объекта.
GetCulture(DependencyObject)

Возвращает значение присоединенного свойства CultureProperty для указанного Объекта DependencyObject.
GetDescribedBy(DependencyObject)

Возвращает коллекцию элементов, предоставляющих дополнительные сведения об указанном элементе автоматизации.
GetFlowsFrom(DependencyObject)

Возвращает список элементов автоматизации, которые предлагают порядок чтения перед указанным элементом автоматизации.
GetFlowsTo(DependencyObject)

Возвращает список элементов автоматизации, которые предлагают порядок чтения после указанного элемента автоматизации.
GetFullDescription(DependencyObject)

Возвращает локализованную строку, описывающую внешний вид или содержимое указанного объекта DependencyObject.
GetHeadingLevel(DependencyObject)

Возвращает значение свойства AutomationProperties.HeadingLevel для указанного DependencyObject.
GetHelpText(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.HelpText для указанного Объекта DependencyObject.
GetIsDataValidForForm(DependencyObject)

Возвращает логическое значение, указывающее, является ли введенное или выбранное значение допустимым для правила формы, связанного с указанным элементом.
GetIsDialog(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.IsDialog для указанного Объекта DependencyObject.
GetIsPeripheral(DependencyObject)

Возвращает логическое значение, указывающее, представляет ли указанный элемент периферийный пользовательский интерфейс.
GetIsRequiredForForm(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.IsRequiredForForm для указанного Объекта DependencyObject.
GetItemStatus(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.ItemStatus для указанного Объекта DependencyObject.
GetItemType(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.ItemType для указанного DependencyObject.
GetLabeledBy(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.LabeledBy для указанного Объекта DependencyObject.
GetLandmarkType(DependencyObject)

Возвращает значение присоединенного свойства типа ориентира для указанного DependencyObject.
GetLevel(DependencyObject)

Возвращает значение свойства для указанного объекта .
GetLiveSetting(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.LiveSetting для указанного Объекта DependencyObject.
GetLocalizedControlType(DependencyObject)

Возвращает локализованную строку, указывающую тип указанного элемента управления.
GetLocalizedLandmarkType(DependencyObject)

Возвращает значение присоединенного свойства локализованного типа ориентира для указанного Объекта DependencyObject.
GetName(DependencyObject)

Возвращает значение присоединенного свойства AutomationProperties.Name для указанного DependencyObject.
GetPositionInSet(DependencyObject)

Возвращает значение свойства для указанного объекта .
GetSizeOfSet(DependencyObject)

Возвращает значение свойства для указанного объекта .
SetAcceleratorKey(DependencyObject, String)

Задает значение присоединенного свойства AutomationProperties.AcceleratorKey для указанного Объекта DependencyObject.
SetAccessibilityView(DependencyObject, AccessibilityView)

Задает значение присоединенного свойства AutomationProperties.AccessibilityView для указанного DependencyObject.
SetAccessKey(DependencyObject, String)

Задает значение присоединенного свойства AutomationProperties.AccessKey для указанного Объекта DependencyObject.
SetAutomationControlType(UIElement, AutomationControlType)

Microsoft.UI.Xaml.Automation.Peers.AutomationControlType Задает для указанного элемента пользовательского интерфейса.
SetAutomationId(DependencyObject, String)

Задает значение присоединенного свойства AutomationProperties.AutomationId для указанного Объекта DependencyObject.
SetCulture(DependencyObject, Int32)

Задает значение присоединенного свойства CultureProperty для указанного DependencyObject.
SetFullDescription(DependencyObject, String)

Задает локализованную строку, описывающую внешний вид или содержимое указанного объекта DependencyObject.
SetHeadingLevel(DependencyObject, AutomationHeadingLevel)

Задает значение свойства AutomationProperties.HeadingLevel для указанного DependencyObject.
SetHelpText(DependencyObject, String)

Задает значение присоединенного свойства AutomationProperties.HelpText для указанного Объекта DependencyObject.
SetIsDataValidForForm(DependencyObject, Boolean)

Задает логическое значение, указывающее, является ли введенное или выбранное значение допустимым для правила формы, связанного с указанным элементом.
SetIsDialog(DependencyObject, Boolean)

Задает логическое значение, указывающее, следует ли идентифицировать указанный элемент как диалоговое окно.
SetIsPeripheral(DependencyObject, Boolean)

Задает логическое значение, указывающее, представляет ли указанный элемент периферийный пользовательский интерфейс.
SetIsRequiredForForm(DependencyObject, Boolean)

Задает значение присоединенного свойства AutomationProperties.IsRequiredForForm для указанного Объекта DependencyObject.
SetItemStatus(DependencyObject, String)

Задает значение присоединенного свойства AutomationProperties.ItemStatus для указанного Объекта DependencyObject.
SetItemType(DependencyObject, String)

Задает значение присоединенного свойства AutomationProperties.ItemType для указанного Объекта DependencyObject.
SetLabeledBy(DependencyObject, UIElement)

Задает значение присоединенного свойства AutomationProperties.LabeledBy для указанного Объекта DependencyObject.
SetLandmarkType(DependencyObject, AutomationLandmarkType)

Задает значение присоединенного свойства типа ориентира для указанного Объекта DependencyObject.
SetLevel(DependencyObject, Int32)

Задает значение присоединенного свойства AutomationProperties.Level для указанного Объекта DependencyObject.
SetLiveSetting(DependencyObject, AutomationLiveSetting)

Задает значение присоединенного свойства AutomationProperties.LiveSetting для указанного Объекта DependencyObject.
SetLocalizedControlType(DependencyObject, String)

Задает локализованную строку, указывающую тип указанного элемента управления.
SetLocalizedLandmarkType(DependencyObject, String)

Задает значение присоединенного свойства локализованного типа ориентира для указанного Объекта DependencyObject.
SetName(DependencyObject, String)

Задает значение присоединенного свойства AutomationProperties.Name для указанного Объекта DependencyObject.
SetPositionInSet(DependencyObject, Int32)

Задает значение присоединенного свойства AutomationProperties.PositionInSet для указанного Объекта DependencyObject.
SetSizeOfSet(DependencyObject, Int32)

Задает значение присоединенного свойства AutomationProperties.SizeOfSet для указанного Объекта DependencyObject.

Применяется к

См. также раздел