AutomationElementIdentifiers Class

Definition

Namespace:

Microsoft.UI.Xaml.Automation

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

public ref class AutomationElementIdentifiers 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 AutomationElementIdentifiers 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 AutomationElementIdentifiers

Public NotInheritable Class AutomationElementIdentifiers

Inheritance

Object Platform::Object IInspectable AutomationElementIdentifiers

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

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 AutomationPeer.RaisePropertyChangedEvent calls that you make from control code that references your own peer, or for Provider.IItemContainerProvider.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	Identifies the accelerator key automation property. The accelerator key property value is returned by the GetAcceleratorKey method.
AccessKeyProperty	Identifies the access key automation property. The access key property value is returned by the GetAccessKey method.
AnnotationsProperty	Gets the identifier for the annotations automation property.
AutomationIdProperty	Identifies the automation element identifier automation property. The automation element identifier value is returned by the GetAutomationId method.
BoundingRectangleProperty	Identifies the bounding rectangle automation property. The bounding rectangle property value is returned by the GetBoundingRectangle method.
ClassNameProperty	Identifies the class name automation property. The class name property value is returned by the GetClassName method.
ClickablePointProperty	Identifies the clickable point automation property. A valid clickable point property value is returned by the GetClickablePoint method.
ControlledPeersProperty	Identifies the controlled peers automation property. A list of controlled peers is returned by the GetControlledPeers method.
ControlTypeProperty	Identifies the control type automation property. The control type property value is returned by the GetAutomationControlType method.
CultureProperty	Identifies the Culture property, which contains a locale identifier for the automation element (for example, 0x0409 for "en-US" or English (United States)).
DescribedByProperty	Identifies the described by automation property.
FlowsFromProperty	Identifies the "flows from" automation property. The "flows from" property value is returned by the GetFlowsFrom method.
FlowsToProperty	Identifies the "flows to" automation property. The "flows to" property value is returned by the GetFlowsTo method.
FullDescriptionProperty	Identifies the full description automation property.
HasKeyboardFocusProperty	Identifies the keyboard focus automation property. The keyboard focus state is returned by the HasKeyboardFocus method.
HeadingLevelProperty	Identifies the heading level automation property. The heading level property value is returned by the GetHeadingLevel method.
HelpTextProperty	Identifies the help text automation property. The help text property value is returned by the GetHelpText method.
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.
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.
IsDataValidForFormProperty	Identifies the Boolean automation property that indicates if the data is valid for the form.
IsDialogProperty	Identifies the Boolean AutomationProperties.IsDialogProperty that indicates whether the automation element is a dialog window.
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.
IsKeyboardFocusableProperty	Identifies the keyboard-focusable determination automation property. The keyboard focusable status is returned by the IsKeyboardFocusable method.
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.
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.
IsPeripheralProperty	Identifies the Boolean automation property that indicates if the automation element represents peripheral UI.
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.
ItemStatusProperty	Identifies the item status automation property. The current item status is returned by the GetItemStatus method.
ItemTypeProperty	Identifies the item type automation property. The item type value is returned by GetItemType method.
LabeledByProperty	Identifies the labeled-by peer automation property. The labeling relationship for an automation peer is returned by the GetLabeledBy method.
LandmarkTypeProperty	Gets the identifier for the landmark type automation property.
LevelProperty	Gets the identifier for the level automation property.
LiveSettingProperty	Identifies the live settings automation property. The live settings property value is returned by the GetLiveSetting method.
LocalizedControlTypeProperty	Identifies the localized control type automation property which provides a mechanism to alter the control type read by Narrator.
LocalizedLandmarkTypeProperty	Gets the identifier for the localized landmark type automation property.
NameProperty	Identifies the element name automation property. The current name is returned by the GetName method.
OrientationProperty	Identifies the orientation automation property. The current orientation value is returned by the GetOrientation method.
PositionInSetProperty	Gets the identifier for the position in set automation property.
SizeOfSetProperty	Gets the identification of the size of set automation property.

See also

• FrameworkElementAutomationPeer
• Automation Element Property Identifiers
• Control patterns and interfaces
• Custom automation peers