AutomationProperties Класс

Определение

Обеспечивает поддержку получения или задания значений на уровне экземпляра свойств автоматизации. Эти значения свойств задаются как присоединенные свойства (обычно в XAML) и дополняют или переопределяют значения свойств автоматизации из AutomationPeer элемента управления.

public ref class AutomationProperties sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 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(Windows.Foundation.UniversalApiContract), 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
Атрибуты

Требования к Windows

Семейство устройств
Windows 10 (появилось в 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (появилось в v1.0)

Примеры

Совет

Откройте приложение коллекции WinUI 3 и ознакомьтесь со следующими принципами специальных возможностей в действии:

Приложение коллекции WinUI 3 содержит интерактивные примеры большинства элементов управления, функций и функций WinUI 3. Получение приложения из Microsoft Store или получение исходного кода на GitHub

Комментарии

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

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

Name - свойство

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

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

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

Полный список см. в разделе Присоединенные свойства (дополнительные сведения о каждом присоединенном свойстве см. в поле Идентификатор каждого свойства).

Журнал версий

Версия Windows Версия пакета SDK Добавленная стоимость
1511 10586 GetLandmarkType
1511 10586 GetLocalizedLandmarkType
1511 10586 SetLandmarkType
1511 10586 SetLocalizedLandmarkType
1607 14393 GetDescribedBy
1607 14393 GetFlowsFrom
1607 14393 GetFlowsTo
1607 14393 GetFullDescription
1607 14393 GetIsDataValidForForm
1607 14393 GetIsPeripheral
1607 14393 GetLocalizedControlType
1607 14393 SetFullDescription
1607 14393 SetIsDataValidForForm
1607 14393 SetIsPeripheral
1607 14393 SetLocalizedControlType
1703 15063 GetCulture
1703 15063 SetCulture
1803 17134 GetHeadingLevel
1803 17134 SetHeadingLevel
1809 17763 GetIsDialog
1809 17763 SetIsDialog

Свойства

AcceleratorKeyProperty

Определяет присоединенное свойство AutomationProperties.AcceleratorKey .

AccessibilityViewProperty

Определяет присоединенное свойство AutomationProperties.AccessibilityView .

AccessKeyProperty

Определяет присоединенное свойство AutomationProperties.AccessKey .

AnnotationsProperty

Определяет присоединенное свойство AutomationProperties.Annotations .

AutomationControlTypeProperty

Определяет присоединенное свойство AutomationProperties.AutomationControlType .

AutomationIdProperty

Определяет присоединенное свойство AutomationProperties.AutomationId .

ControlledPeersProperty

Определяет присоединенное свойство AutomationProperties.ControlledPeers .

CultureProperty

Определяет присоединенное свойство AutomationProperties.Culture .

DescribedByProperty

Определяет присоединенное свойство AutomationProperties.DescribedBy .

FlowsFromProperty

Идентифицирует присоединенное свойство FlowsFrom .

FlowsToProperty

Определяет присоединенное свойство FlowsTo .

FullDescriptionProperty

Определяет присоединенное свойство XAML AutomationProperties.FullDescription .

HeadingLevelProperty

Идентифицирует присоединенное свойство XAML HeadingLevel .

HelpTextProperty

Определяет присоединенное свойство XAML AutomationProperties.HelpText .

IsDataValidForFormProperty

Определяет присоединенное свойство XAML AutomationProperties.IsDataValidForForm .

IsDialogProperty

Определяет присоединенное свойство XAML AutomationProperties.IsDialog .

IsPeripheralProperty

Определяет присоединенное свойство XAML AutomationProperties.IsPeripheral .

IsRequiredForFormProperty

Определяет присоединенное свойство XAML AutomationProperties.IsRequiredForForm .

ItemStatusProperty

Определяет присоединенное свойство XAML AutomationProperties.ItemStatus .

ItemTypeProperty

Определяет присоединенное свойство XAML AutomationProperties.ItemType .

LabeledByProperty

Определяет присоединенное свойство XAML AutomationProperties.LabeledBy .

LandmarkTypeProperty

Определяет присоединенное свойство XAML AutomationProperties.LandmarkType .

LevelProperty

Определяет присоединенное свойство XAML AutomationProperties.Level .

LiveSettingProperty

Определяет присоединенное свойство XAML AutomationProperties.LiveSetting .

LocalizedControlTypeProperty

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

LocalizedLandmarkTypeProperty

Определяет присоединенное свойство XAML AutomationProperties.LocalizedLandmarkType .

NameProperty

Идентифицирует присоединенное свойство AUTOMATIONPROPERTIES.NAME XAML.

PositionInSetProperty

Определяет присоединенное свойство XAML AutomationProperties.PositionInSet .

SizeOfSetProperty

Определяет присоединенное свойство XAML AutomationProperties.SizeOfSet .

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

AcceleratorKey

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

AccessibilityView

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

AccessKey

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

Annotations

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

AutomationControlType

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

AutomationId

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

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)

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

GetAutomationId(DependencyObject)

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

GetControlledPeers(DependencyObject)

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

GetCulture(DependencyObject)

Возвращает значение присоединенного свойства XAML языка и региональных параметров для указанного DependencyObject.

GetDescribedBy(DependencyObject)

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

GetFlowsFrom(DependencyObject)

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

GetFlowsTo(DependencyObject)

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

GetFullDescription(DependencyObject)

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

GetHeadingLevel(DependencyObject)

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

GetHelpText(DependencyObject)

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

GetIsDataValidForForm(DependencyObject)

Возвращает значение свойства AutomationProperties.IsDataValidForForm для указанного 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)

Возвращает значение свойства AutomationProperties.Level для указанного элемента.

GetLiveSetting(DependencyObject)

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

GetLocalizedControlType(DependencyObject)

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

GetLocalizedLandmarkType(DependencyObject)

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

GetName(DependencyObject)

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

GetPositionInSet(DependencyObject)

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

GetSizeOfSet(DependencyObject)

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

SetAcceleratorKey(DependencyObject, String)

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

SetAccessibilityView(DependencyObject, AccessibilityView)

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

SetAccessKey(DependencyObject, String)

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

SetAutomationControlType(UIElement, AutomationControlType)

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

SetAutomationId(DependencyObject, String)

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

SetCulture(DependencyObject, Int32)

Задает значение присоединенного свойства Culture для указанного 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.

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

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