AutomationElementIdentifiers AutomationElementIdentifiers AutomationElementIdentifiers AutomationElementIdentifiers Class

Definition

Contains values used as automation property identifiers by UI Automation providers and UI Automation clients.

public : sealed class AutomationElementIdentifiers : IAutomationElementIdentifiers
public sealed class AutomationElementIdentifiers : IAutomationElementIdentifiers
Public NotInheritable Class AutomationElementIdentifiers Implements IAutomationElementIdentifiers
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Classes such as AutomationElementIdentifiers are the identifiers for the Windows Runtime implementation of a common provider pattern for Microsoft UI Automation. AutomationElementIdentifiers identifies the general automation peer properties that are part of the basic peer functionality, as opposed to being related to a specific automation control pattern. You might use these identifiers if you are implementing a Windows Runtime custom automation peer based on AutomationPeer or FrameworkElementAutomationPeer. These identifiers are needed for the RaisePropertyChangedEvent calls that you make from control code that references your own peer, or for FindItemByProperty in an items container peer.

This same set of property identifiers is usually exposed to clients in a different way, depending on which technology they use to implement the client and examine the Microsoft UI Automation tree. One such property identifier list for clients is documented in the topic Automation Element Property Identifiers.

Properties

AcceleratorKeyProperty AcceleratorKeyProperty AcceleratorKeyProperty AcceleratorKeyProperty

Identifies the accelerator key automation property. The accelerator key property value is returned by the GetAcceleratorKey method.

public : static AutomationProperty AcceleratorKeyProperty { get; }
public static AutomationProperty AcceleratorKeyProperty { get; }
Public Static ReadOnly Property AcceleratorKeyProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.acceleratorKeyProperty;

AccessKeyProperty AccessKeyProperty AccessKeyProperty AccessKeyProperty

Identifies the access key automation property. The access key property value is returned by the GetAccessKey method.

public : static AutomationProperty AccessKeyProperty { get; }
public static AutomationProperty AccessKeyProperty { get; }
Public Static ReadOnly Property AccessKeyProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.accessKeyProperty;

AnnotationsProperty AnnotationsProperty AnnotationsProperty AnnotationsProperty

Gets the identifier for the annotations automation property.

public : static AutomationProperty AnnotationsProperty { get; }
public static AutomationProperty AnnotationsProperty { get; }
Public Static ReadOnly Property AnnotationsProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.annotationsProperty;
Value
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

The identifier for the annotations automation property.

AutomationIdProperty AutomationIdProperty AutomationIdProperty AutomationIdProperty

Identifies the automation element identifier automation property. The automation element identifier value is returned by the GetAutomationId method.

public : static AutomationProperty AutomationIdProperty { get; }
public static AutomationProperty AutomationIdProperty { get; }
Public Static ReadOnly Property AutomationIdProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.automationIdProperty;

BoundingRectangleProperty BoundingRectangleProperty BoundingRectangleProperty BoundingRectangleProperty

Identifies the bounding rectangle automation property. The bounding rectangle property value is returned by the GetBoundingRectangle method.

public : static AutomationProperty BoundingRectangleProperty { get; }
public static AutomationProperty BoundingRectangleProperty { get; }
Public Static ReadOnly Property BoundingRectangleProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.boundingRectangleProperty;

ClassNameProperty ClassNameProperty ClassNameProperty ClassNameProperty

Identifies the class name automation property. The class name property value is returned by the GetClassName method.

public : static AutomationProperty ClassNameProperty { get; }
public static AutomationProperty ClassNameProperty { get; }
Public Static ReadOnly Property ClassNameProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.classNameProperty;

ClickablePointProperty ClickablePointProperty ClickablePointProperty ClickablePointProperty

Identifies the clickable point automation property. A valid clickable point property value is returned by the GetClickablePoint method.

public : static AutomationProperty ClickablePointProperty { get; }
public static AutomationProperty ClickablePointProperty { get; }
Public Static ReadOnly Property ClickablePointProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.clickablePointProperty;

ControlledPeersProperty ControlledPeersProperty ControlledPeersProperty ControlledPeersProperty

Identifies the controlled peers automation property. A list of controlled peers is returned by the GetControlledPeers method.

public : static AutomationProperty ControlledPeersProperty { get; }
public static AutomationProperty ControlledPeersProperty { get; }
Public Static ReadOnly Property ControlledPeersProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.controlledPeersProperty;

ControlTypeProperty ControlTypeProperty ControlTypeProperty ControlTypeProperty

Identifies the control type automation property. The control type property value is returned by the GetAutomationControlType method.

public : static AutomationProperty ControlTypeProperty { get; }
public static AutomationProperty ControlTypeProperty { get; }
Public Static ReadOnly Property ControlTypeProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.controlTypeProperty;

CultureProperty CultureProperty CultureProperty CultureProperty

Identifies the Culture property, which contains a locale identifier for the automation element (for example, 0x0409 for "en-US" or English (United States)).

public : static AutomationProperty CultureProperty { get; }
public static AutomationProperty CultureProperty { get; }
Public Static ReadOnly Property CultureProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.cultureProperty;
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

Each locale has a unique identifier, a 32-bit value that consists of a language identifier and a sort order identifier. The locale identifier is a standard international numeric abbreviation and has the components necessary to uniquely identify one of the installed operating system-defined locales. For more information, see Language Identifier Constants and Strings.

This property may exist on a per-control basis, but typically is only available on an application level.

DescribedByProperty DescribedByProperty DescribedByProperty DescribedByProperty

Identifies the described by automation property.

public : static AutomationProperty DescribedByProperty { get; }
public static AutomationProperty DescribedByProperty { get; }
Public Static ReadOnly Property DescribedByProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.describedByProperty;
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

The collection of elements that provide more information about the automation element is returned by the GetDescribedBy method.

FlowsFromProperty FlowsFromProperty FlowsFromProperty FlowsFromProperty

Identifies the "flows from" automation property. The "flows from" property value is returned by the GetFlowsFrom method.

public : static AutomationProperty FlowsFromProperty { get; }
public static AutomationProperty FlowsFromProperty { get; }
Public Static ReadOnly Property FlowsFromProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.flowsFromProperty;
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FlowsToProperty FlowsToProperty FlowsToProperty FlowsToProperty

Identifies the "flows to" automation property. The "flows to" property value is returned by the GetFlowsTo method.

public : static AutomationProperty FlowsToProperty { get; }
public static AutomationProperty FlowsToProperty { get; }
Public Static ReadOnly Property FlowsToProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.flowsToProperty;
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FullDescriptionProperty FullDescriptionProperty FullDescriptionProperty FullDescriptionProperty

Identifies the full description automation property.

public : static AutomationProperty FullDescriptionProperty { get; }
public static AutomationProperty FullDescriptionProperty { get; }
Public Static ReadOnly Property FullDescriptionProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.fullDescriptionProperty;
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

A localized string that describes the visual appearance or contents of something such as an image or image control is returned by the GetFullDescription method.

HasKeyboardFocusProperty HasKeyboardFocusProperty HasKeyboardFocusProperty HasKeyboardFocusProperty

Identifies the keyboard focus automation property. The keyboard focus state is returned by the HasKeyboardFocus method.

public : static AutomationProperty HasKeyboardFocusProperty { get; }
public static AutomationProperty HasKeyboardFocusProperty { get; }
Public Static ReadOnly Property HasKeyboardFocusProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.hasKeyboardFocusProperty;

HelpTextProperty HelpTextProperty HelpTextProperty HelpTextProperty

Identifies the help text automation property. The help text property value is returned by the GetHelpText method.

public : static AutomationProperty HelpTextProperty { get; }
public static AutomationProperty HelpTextProperty { get; }
Public Static ReadOnly Property HelpTextProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.helpTextProperty;

IsContentElementProperty IsContentElementProperty IsContentElementProperty IsContentElementProperty

Identifies the content element determination automation property. The content element status indicates whether the element contains content that is valuable to the end user. The current status is returned by the IsContentElement method.

public : static AutomationProperty IsContentElementProperty { get; }
public static AutomationProperty IsContentElementProperty { get; }
Public Static ReadOnly Property IsContentElementProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.isContentElementProperty;

IsControlElementProperty IsControlElementProperty IsControlElementProperty IsControlElementProperty

Identifies the control element determination automation property. The control element status indicates whether the element contains user interface components that can be manipulated. The current status is returned by the IsControlElement method.

public : static AutomationProperty IsControlElementProperty { get; }
public static AutomationProperty IsControlElementProperty { get; }
Public Static ReadOnly Property IsControlElementProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.isControlElementProperty;

IsDataValidForFormProperty IsDataValidForFormProperty IsDataValidForFormProperty IsDataValidForFormProperty

Identifies the Boolean automation property that indicates if the data is valid for the form.

public : static AutomationProperty IsDataValidForFormProperty { get; }
public static AutomationProperty IsDataValidForFormProperty { get; }
Public Static ReadOnly Property IsDataValidForFormProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.isDataValidForFormProperty;
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

A Boolean that indicates if the data is valid for the form is returned by the GetIsDataValidForForm method.

IsEnabledProperty IsEnabledProperty IsEnabledProperty IsEnabledProperty

Identifies the enabled determination automation property. The enabled status indicates whether the item referenced by the automation peer is enabled. The current status is returned by the IsEnabled method.

public : static AutomationProperty IsEnabledProperty { get; }
public static AutomationProperty IsEnabledProperty { get; }
Public Static ReadOnly Property IsEnabledProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.isEnabledProperty;

IsKeyboardFocusableProperty IsKeyboardFocusableProperty IsKeyboardFocusableProperty IsKeyboardFocusableProperty

Identifies the keyboard-focusable determination automation property. The keyboard focusable status is returned by the IsKeyboardFocusable method.

public : static AutomationProperty IsKeyboardFocusableProperty { get; }
public static AutomationProperty IsKeyboardFocusableProperty { get; }
Public Static ReadOnly Property IsKeyboardFocusableProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.isKeyboardFocusableProperty;

IsOffscreenProperty IsOffscreenProperty IsOffscreenProperty IsOffscreenProperty

Identifies the offscreen determination automation property. The offscreen status indicates whether the item referenced by the automation peer is off the screen. The current status is returned by the IsOffscreen method.

public : static AutomationProperty IsOffscreenProperty { get; }
public static AutomationProperty IsOffscreenProperty { get; }
Public Static ReadOnly Property IsOffscreenProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.isOffscreenProperty;

IsPasswordProperty IsPasswordProperty IsPasswordProperty IsPasswordProperty

Identifies the password determination automation property. The password status indicates whether the item referenced by the automation peer contains a password. The current status is returned by the IsPassword method.

public : static AutomationProperty IsPasswordProperty { get; }
public static AutomationProperty IsPasswordProperty { get; }
Public Static ReadOnly Property IsPasswordProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.isPasswordProperty;

IsPeripheralProperty IsPeripheralProperty IsPeripheralProperty IsPeripheralProperty

Identifies the Boolean automation property that indicates if the automation element represents peripheral UI.

public : static AutomationProperty IsPeripheralProperty { get; }
public static AutomationProperty IsPeripheralProperty { get; }
Public Static ReadOnly Property IsPeripheralProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.isPeripheralProperty;
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

A Boolean that indicates the automation element represents peripheral UI is returned by the GetIsPeripheral method.

IsRequiredForFormProperty IsRequiredForFormProperty IsRequiredForFormProperty IsRequiredForFormProperty

Identifies the form requirement determination automation property. The form requirement status indicates whether the element must be completed on a form. The current status is returned by the IsRequiredForForm method.

public : static AutomationProperty IsRequiredForFormProperty { get; }
public static AutomationProperty IsRequiredForFormProperty { get; }
Public Static ReadOnly Property IsRequiredForFormProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.isRequiredForFormProperty;

ItemStatusProperty ItemStatusProperty ItemStatusProperty ItemStatusProperty

Identifies the item status automation property. The current item status is returned by the GetItemStatus method.

public : static AutomationProperty ItemStatusProperty { get; }
public static AutomationProperty ItemStatusProperty { get; }
Public Static ReadOnly Property ItemStatusProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.itemStatusProperty;

ItemTypeProperty ItemTypeProperty ItemTypeProperty ItemTypeProperty

Identifies the item type automation property. The item type value is returned by GetItemType method.

public : static AutomationProperty ItemTypeProperty { get; }
public static AutomationProperty ItemTypeProperty { get; }
Public Static ReadOnly Property ItemTypeProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.itemTypeProperty;

LabeledByProperty LabeledByProperty LabeledByProperty LabeledByProperty

Identifies the labeled-by peer automation property. The labeling relationship for an automation peer is returned by the GetLabeledBy method.

public : static AutomationProperty LabeledByProperty { get; }
public static AutomationProperty LabeledByProperty { get; }
Public Static ReadOnly Property LabeledByProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.labeledByProperty;

LandmarkTypeProperty LandmarkTypeProperty LandmarkTypeProperty LandmarkTypeProperty

Gets the identifier for the landmark type automation property.

public : static AutomationProperty LandmarkTypeProperty { get; }
public static AutomationProperty LandmarkTypeProperty { get; }
Public Static ReadOnly Property LandmarkTypeProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.landmarkTypeProperty;
Value
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

The identifier for the landmark type automation property.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Remarks

Landmarks are defined by their type, which can be a well-known value, or a custom localized string.

LevelProperty LevelProperty LevelProperty LevelProperty

Gets the identifier for the level automation property.

public : static AutomationProperty LevelProperty { get; }
public static AutomationProperty LevelProperty { get; }
Public Static ReadOnly Property LevelProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.levelProperty;
Value
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

The identifier for the level automation property.

LiveSettingProperty LiveSettingProperty LiveSettingProperty LiveSettingProperty

Identifies the live settings automation property. The live settings property value is returned by the GetLiveSetting method.

public : static AutomationProperty LiveSettingProperty { get; }
public static AutomationProperty LiveSettingProperty { get; }
Public Static ReadOnly Property LiveSettingProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.liveSettingProperty;

LocalizedControlTypeProperty LocalizedControlTypeProperty LocalizedControlTypeProperty LocalizedControlTypeProperty

Identifies the localized control type automation property which provides a mechanism to alter the control type read by Narrator.

public : static AutomationProperty LocalizedControlTypeProperty { get; }
public static AutomationProperty LocalizedControlTypeProperty { get; }
Public Static ReadOnly Property LocalizedControlTypeProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.localizedControlTypeProperty;

Remarks

The current localized control type is returned by the GetLocalizedControlTypeCore method.

LocalizedLandmarkTypeProperty LocalizedLandmarkTypeProperty LocalizedLandmarkTypeProperty LocalizedLandmarkTypeProperty

Gets the identifier for the localized landmark type automation property.

public : static AutomationProperty LocalizedLandmarkTypeProperty { get; }
public static AutomationProperty LocalizedLandmarkTypeProperty { get; }
Public Static ReadOnly Property LocalizedLandmarkTypeProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.localizedLandmarkTypeProperty;
Value
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

The identifier for the localized landmark type automation property.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Remarks

Landmarks are defined by their type, which can be a well-known value, or a custom localized string.

NameProperty NameProperty NameProperty NameProperty

Identifies the element name automation property. The current name is returned by the GetName method.

public : static AutomationProperty NameProperty { get; }
public static AutomationProperty NameProperty { get; }
Public Static ReadOnly Property NameProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.nameProperty;

OrientationProperty OrientationProperty OrientationProperty OrientationProperty

Identifies the orientation automation property. The current orientation value is returned by the GetOrientation method.

public : static AutomationProperty OrientationProperty { get; }
public static AutomationProperty OrientationProperty { get; }
Public Static ReadOnly Property OrientationProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.orientationProperty;

PositionInSetProperty PositionInSetProperty PositionInSetProperty PositionInSetProperty

Gets the identifier for the position in set automation property.

public : static AutomationProperty PositionInSetProperty { get; }
public static AutomationProperty PositionInSetProperty { get; }
Public Static ReadOnly Property PositionInSetProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.positionInSetProperty;
Value
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

The identifier for the position in set automation property.

SizeOfSetProperty SizeOfSetProperty SizeOfSetProperty SizeOfSetProperty

Gets the identification of the size of set automation property.

public : static AutomationProperty SizeOfSetProperty { get; }
public static AutomationProperty SizeOfSetProperty { get; }
Public Static ReadOnly Property SizeOfSetProperty As AutomationProperty
var automationProperty = Windows.UI.Xaml.Automation.AutomationElementIdentifiers.sizeOfSetProperty;
Value
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

The identification of the size of set automation property.

See Also