AutomationProperties AutomationProperties AutomationProperties Class

Definition

Provides support for getting or setting instance-level values of automation properties. These property values are set as attached properties (typically in XAML) and supplement or override automation property values from a control's AutomationPeer.

public sealed class AutomationPropertiespublic sealed class AutomationPropertiesPublic NotInheritable Class AutomationProperties
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

AutomationProperties XAML attached properties

AutomationProperties is the host service class for several XAML attached properties. The purpose of these attached properties is to enable setting various per-instance values that are pertinent to how a UI element is reported to the Microsoft UI Automation accessibility framework. This is useful in cases where the class design of the UI element doesn't already forward other UI-related property values as part of its Microsoft UI Automation integration or peer implementation behavior, or where the value being forwarded is not the value you want to report to Microsoft UI Automation.

These are the XAML attached properties that are supported by AutomationProperties:

AutomationProperties.Name

Of the various attached properties, probably the most important one is NameProperty. This is because it is the Name property that is most frequently accessed and reported by assistive technology when users interact with an app in an accessibility scenario. The Name serves as the human-readable identifier for the UI element.

Various UI elements have peer forwarding that can provide a default Name value based on other element properties. For example, the peer forwarding for the Button class will forward the ToString evaluation of the Button content and use this string as the default Name. In order to override that default, or to otherwise provide a Name value for any UI element case where there is no Microsoft UI Automation Name available, set the NameProperty attached property on that element in XAML. For more info on why a Microsoft UI Automation Name is important, see Basic accessibility information. For more info on how to test whether an element already has a peer-supplied Name that is useful, see Accessibility testing.

For localization reasons, you should avoid hard-coded string values for the NameProperty in XAML. If you set x:Uid directive on the element, then you can use RESW resources to target the property and provide different values for localization. For attached properties, the resource identifier form requires full qualification of the attached property in XAML form, including its namespace and a using: prefix. For example, to target the AutomationProperties.Name attached property value on a resource that has x:Uid directive value of "sendButton", the name value of the data item in the RESW resources is sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name

Properties

AcceleratorKeyProperty AcceleratorKeyProperty AcceleratorKeyProperty AcceleratorKeyProperty

Identifies the AcceleratorKeyProperty attached property, which is a string containing the accelerator key (also called shortcut key) combinations for the automation element.

public static DependencyProperty AcceleratorKeyProperty { get; }public static DependencyProperty AcceleratorKeyProperty { get; }Public Static ReadOnly Property AcceleratorKeyProperty As DependencyPropertypublic static DependencyProperty AcceleratorKeyProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the AcceleratorKeyProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Shortcut key combinations invoke an action. For example, CTRL+O is often used to invoke the Open file common dialog box. An automation element that has the AcceleratorKeyProperty property can implement the Invoke control pattern for the action that is equivalent to the shortcut command.

AccessibilityViewProperty AccessibilityViewProperty AccessibilityViewProperty AccessibilityViewProperty

Identifies the AccessibilityViewProperty attached property. Set this attached property on individual elements in order to change their element visibility to specific modes requested by a UI Automation client.

public static DependencyProperty AccessibilityViewProperty { get; }public static DependencyProperty AccessibilityViewProperty { get; }Public Static ReadOnly Property AccessibilityViewProperty As DependencyPropertypublic static DependencyProperty AccessibilityViewProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the AccessibilityViewProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

AccessKeyProperty AccessKeyProperty AccessKeyProperty AccessKeyProperty

Identifies the AccessKeyProperty attached property, which is a string containing the access key character for the automation element.

public static DependencyProperty AccessKeyProperty { get; }public static DependencyProperty AccessKeyProperty { get; }Public Static ReadOnly Property AccessKeyProperty As DependencyPropertypublic static DependencyProperty AccessKeyProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the AccessKeyProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

An access key (sometimes called a mnemonic) is a character in the text of a menu, menu item, or label of a control such as a button, that activates the associated menu function. For example, to open the File menu, for which the access key is typically F, the user would press ALT+F.

AnnotationsProperty AnnotationsProperty AnnotationsProperty AnnotationsProperty

Identifies a dependency property that's used for a list of annotation objects in a document, such as comment, header, footer, and so on.

public static DependencyProperty AnnotationsProperty { get; }public static DependencyProperty AnnotationsProperty { get; }Public Static ReadOnly Property AnnotationsProperty As DependencyPropertypublic static DependencyProperty AnnotationsProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the Annotations attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

There's no public dependency property for Annotations. Use GetAnnotations(DependencyObject) to get the list of annotations.

AutomationIdProperty AutomationIdProperty AutomationIdProperty AutomationIdProperty

Identifies the AutomationIdProperty attached property, which is a string containing the UI Automation identifier (ID) for the automation element.

public static DependencyProperty AutomationIdProperty { get; }public static DependencyProperty AutomationIdProperty { get; }Public Static ReadOnly Property AutomationIdProperty As DependencyPropertypublic static DependencyProperty AutomationIdProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the AutomationIdProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

When it is available, the AutomationIdProperty of an element must be the same in any instance of the application, regardless of the local language. The value should be unique among sibling elements, but not necessarily unique across the entire desktop. For example, multiple instances of an application, or multiple folder views in Windows Explorer, can contain elements with the same AutomationIdProperty property, such as "SystemMenuBar".

Although support for AutomationIdProperty is always recommended for better automated testing support, this property is not mandatory. Where it is supported, AutomationIdProperty is useful for creating a test automation script that runs regardless of the UI language. Clients should make no assumptions regarding the AutomationIdProperty values exposed by other applications. AutomationIdProperty is not guaranteed to be stable across different releases or builds of an application.

ControlledPeersProperty ControlledPeersProperty ControlledPeersProperty ControlledPeersProperty

Identifies a dependency property that's used for controlled peers, which is an array of automation elements that are manipulated by the automation element that supports this property.

public static DependencyProperty ControlledPeersProperty { get; }public static DependencyProperty ControlledPeersProperty { get; }Public Static ReadOnly Property ControlledPeersProperty As DependencyPropertypublic static DependencyProperty ControlledPeersProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

A dependency property identifier.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

There's no public dependency property for ControlledPeers because this is an advanced scenario. Use GetControlledPeers(DependencyObject) to get the list of controlled automation elements.

ControlledPeers is used when an automation element affects one or more segments of the application UI or the desktop; otherwise, it is hard to associate the impact of the control operation with UI elements.

CultureProperty CultureProperty CultureProperty CultureProperty

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

public static DependencyProperty CultureProperty { get; }public static DependencyProperty CultureProperty { get; }Public Static ReadOnly Property CultureProperty As DependencyPropertypublic static DependencyProperty CultureProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the culture attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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

Gets the identifier for the described by attached property, which is an array of elements that provide more information about the automation element.

public static DependencyProperty DescribedByProperty { get; }public static DependencyProperty DescribedByProperty { get; }Public Static ReadOnly Property DescribedByProperty As DependencyPropertypublic static DependencyProperty DescribedByProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the described by attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

DescribedBy is used when an automation element is explained by another segment of the application UI. For example, the property can point to a text element of "2,529 items in 85 groups, 10 items selected" from a complex custom list object. Instead of using the object model for clients to digest similar information, the DescribedBy property can offer quick access to the UI element that may already offer useful end-user information that describes the UI element.

FlowsFromProperty FlowsFromProperty FlowsFromProperty FlowsFromProperty

Gets the identifier for the FlowsFrom attached property, which is an array of automation elements that suggests the reading order before the current automation element.

public static DependencyProperty FlowsFromProperty { get; }public static DependencyProperty FlowsFromProperty { get; }Public Static ReadOnly Property FlowsFromProperty As DependencyPropertypublic static DependencyProperty FlowsFromProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the FlowsFrom attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The FlowsFrom property specifies the reading order when automation elements are not exposed or structured in the same reading order as perceived by the user. While the FlowsFrom property can specify multiple preceding elements, it typically contains only the prior element in the reading order.

FlowsToProperty FlowsToProperty FlowsToProperty FlowsToProperty

Gets the identifier for the FlowsTo attached property, which is an array of automation elements that suggests the reading order after the current automation element.

public static DependencyProperty FlowsToProperty { get; }public static DependencyProperty FlowsToProperty { get; }Public Static ReadOnly Property FlowsToProperty As DependencyPropertypublic static DependencyProperty FlowsToProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the "flows to" attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The FlowsTo property specifies the reading order when automation elements are not exposed or structured in the same reading order as perceived by the user. While the FlowsTo property can specify multiple succeeding elements, it typically contains only the next element in the reading order.

FullDescriptionProperty FullDescriptionProperty FullDescriptionProperty FullDescriptionProperty

Gets the identifier for the full description attached property, which exposes a localized string containing extended description text for an element.

public static DependencyProperty FullDescriptionProperty { get; }public static DependencyProperty FullDescriptionProperty { get; }Public Static ReadOnly Property FullDescriptionProperty As DependencyPropertypublic static DependencyProperty FullDescriptionProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the full description attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

FullDescription can contain a more complete description of an element than may be appropriate for the element NameProperty.

HelpTextProperty HelpTextProperty HelpTextProperty HelpTextProperty

Identifies the HelpTextProperty attached property, which is a help text string associated with the automation element.

public static DependencyProperty HelpTextProperty { get; }public static DependencyProperty HelpTextProperty { get; }Public Static ReadOnly Property HelpTextProperty As DependencyPropertypublic static DependencyProperty HelpTextProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the HelpTextProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The HelpTextProperty property is typically obtained from tooltip text associated with the element. The property can also be supported with placeholder text appearing in edit or list controls. For example, "Type text here for search" is a good candidate the HelpTextProperty property for an edit control that places the text prior to the user's actual input. However, it is not adequate for the name property of the edit control.

When HelpTextProperty is supported, the string must match the application UI language or the operating system default UI language.

IsDataValidForFormProperty IsDataValidForFormProperty IsDataValidForFormProperty IsDataValidForFormProperty

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

public static DependencyProperty IsDataValidForFormProperty { get; }public static DependencyProperty IsDataValidForFormProperty { get; }Public Static ReadOnly Property IsDataValidForFormProperty As DependencyPropertypublic static DependencyProperty IsDataValidForFormProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The dependency property identifier.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The IsDataValidForForm property indicates whether the entered or selected value is valid for the form rule associated with the automation element. For example, if the user entered "425-555-5555" for a zip code field that requires 5 or 9 digits, the IsDataValidForForm property can be set to false to indicate that the data is not valid.

IsPeripheralProperty IsPeripheralProperty IsPeripheralProperty IsPeripheralProperty

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

public static DependencyProperty IsPeripheralProperty { get; }public static DependencyProperty IsPeripheralProperty { get; }Public Static ReadOnly Property IsPeripheralProperty As DependencyPropertypublic static DependencyProperty IsPeripheralProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The dependency property identifier.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Peripheral UI appears and supports user interaction, but does not take keyboard focus when it appears. Examples of peripheral UI includes popups, flyouts, context menus, or floating notifications.

When the IsPeripheral property is true, a client application can't assume that focus was taken by the element even if it's currently keyboard-interactive.

This property is relevant for these control types:

  • Group controls
  • Menu controls
  • Pane controls
  • ToolBar controls
  • ToolTip controls
  • Window controls
  • Custom controls

IsRequiredForFormProperty IsRequiredForFormProperty IsRequiredForFormProperty IsRequiredForFormProperty

Identifies the IsRequiredForFormProperty attached property, which is a Boolean value that indicates whether the automation element is required to be filled out on a form.

public static DependencyProperty IsRequiredForFormProperty { get; }public static DependencyProperty IsRequiredForFormProperty { get; }Public Static ReadOnly Property IsRequiredForFormProperty As DependencyPropertypublic static DependencyProperty IsRequiredForFormProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the IsRequiredForFormProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

ItemStatusProperty ItemStatusProperty ItemStatusProperty ItemStatusProperty

Identifies the ItemStatusProperty attached property, which is a text string describing the status of an item of the automation element.

public static DependencyProperty ItemStatusProperty { get; }public static DependencyProperty ItemStatusProperty { get; }Public Static ReadOnly Property ItemStatusProperty As DependencyPropertypublic static DependencyProperty ItemStatusProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the ItemStatusProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

ItemStatusProperty enables a client to ascertain whether an element is conveying status about an item as well as what the status is. For example, an item associated with a contact in a messaging application might be "Busy" or "Connected".

When ItemStatusProperty is supported, the string must match the application UI language or the operating system default UI language.

ItemTypeProperty ItemTypeProperty ItemTypeProperty ItemTypeProperty

Identifies the ItemTypeProperty attached property, which is a text string describing the type of the automation element.

public static DependencyProperty ItemTypeProperty { get; }public static DependencyProperty ItemTypeProperty { get; }Public Static ReadOnly Property ItemTypeProperty As DependencyPropertypublic static DependencyProperty ItemTypeProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the ItemTypeProperty dependency property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

ItemTypeProperty is used to obtain information about items in a list, tree view, or data grid. For example, an item in a file directory view might be a "Document File" or a "Folder".

When ItemTypeProperty is supported, the string must match the application UI language or the operating system default UI language.

LabeledByProperty LabeledByProperty LabeledByProperty LabeledByProperty

Identifies the LabeledByProperty attached property, which is an automation element that contains the text label for this element.

public static DependencyProperty LabeledByProperty { get; }public static DependencyProperty LabeledByProperty { get; }Public Static ReadOnly Property LabeledByProperty As DependencyPropertypublic static DependencyProperty LabeledByProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the LabeledByProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

This property can be used to retrieve, for example, the static text label for a combo box.

LandmarkTypeProperty LandmarkTypeProperty LandmarkTypeProperty LandmarkTypeProperty

Gets the identifier for the landmark type attached property, which is a Landmark Type Identifier associated with an element.

public static DependencyProperty LandmarkTypeProperty { get; }public static DependencyProperty LandmarkTypeProperty { get; }Public Static ReadOnly Property LandmarkTypeProperty As DependencyPropertypublic static DependencyProperty LandmarkTypeProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the landmark type attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The LandmarkType property describes an element that represents a group of elements. For example, a search landmark could represent a set of related controls for searching.

If CustomLandmarkType is used then GetLocalizedLandmarkType(DependencyObject) is required to describe the custom landmark.

LevelProperty LevelProperty LevelProperty LevelProperty

Gets the identifier for the Level attached property, which is a 1-based integer associated with an automation element.

public static DependencyProperty LevelProperty { get; }public static DependencyProperty LevelProperty { get; }Public Static ReadOnly Property LevelProperty As DependencyPropertypublic static DependencyProperty LevelProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the Level attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The Level property describes the location of an element inside hierarchical or broken hierarchical structures. For example, a bulleted or numbered list, headings, or other structured data items can have various parent/child relationships. Level describes where in the structure the item is located.

Use the CustomNavigation Control Pattern in tandem with Level.

LiveSettingProperty LiveSettingProperty LiveSettingProperty LiveSettingProperty

Identifies the LiveSettingProperty attached property, which is supported by an automation element that represents a live region.

public static DependencyProperty LiveSettingProperty { get; }public static DependencyProperty LiveSettingProperty { get; }Public Static ReadOnly Property LiveSettingProperty As DependencyPropertypublic static DependencyProperty LiveSettingProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The property identifier for the LiveSettingProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The LiveSettingProperty property indicates the "politeness" level that a client should use to notify the user of changes to the live region. This property can be one of the values from the AutomationLiveSetting enumeration.

LocalizedControlTypeProperty LocalizedControlTypeProperty LocalizedControlTypeProperty LocalizedControlTypeProperty

Identifies the localized control type dependency property, which is a text string describing the type of control that the automation element represents.

public static DependencyProperty LocalizedControlTypeProperty { get; }public static DependencyProperty LocalizedControlTypeProperty { get; }Public Static ReadOnly Property LocalizedControlTypeProperty As DependencyPropertypublic static DependencyProperty LocalizedControlTypeProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The dependency property identifier.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The string should contain only lowercase characters:

  • Correct: "button"
  • Incorrect: "Button"

When LocalizedControlType is not specified by the element provider, the default localized string is supplied by the framework, according to the control type of the element (for example, "button" for the Button control type). An automation element with the Custom control type must support a localized control type string that represents the role of the element (for example, "color picker" for a custom control that enables users to choose and specify colors).

When a custom value is supplied, the string must match the application UI language or the operating system default UI language.

LocalizedLandmarkTypeProperty LocalizedLandmarkTypeProperty LocalizedLandmarkTypeProperty LocalizedLandmarkTypeProperty

Gets the identifier for the localized landmark type attached property, which is a localized text string describing the type of landmark that the automation element represents.

public static DependencyProperty LocalizedLandmarkTypeProperty { get; }public static DependencyProperty LocalizedLandmarkTypeProperty { get; }Public Static ReadOnly Property LocalizedLandmarkTypeProperty As DependencyPropertypublic static DependencyProperty LocalizedLandmarkTypeProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the localized landmark type attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

This should be used in tandem with UIA_CustomLandmarkTypeId however, LocalizedLandmarkType should always take precedence over LandmarkType and be used to describe the landmark before LandmarkType.

The string must match the application UI language or the operating system default UI language.

NameProperty NameProperty NameProperty NameProperty

Identifies the NameProperty attached property, which is a string that holds the name of the automation element.

public static DependencyProperty NameProperty { get; }public static DependencyProperty NameProperty { get; }Public Static ReadOnly Property NameProperty As DependencyPropertypublic static DependencyProperty NameProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the NameProperty attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The NameProperty property should be the same as the label text on screen. For example, NameProperty should be "Browse" for a button element with the label "Browse". The NameProperty property must not include the mnemonic character for the access keys (that is, "&"), which is underlined in the UI text presentation. Also, the NameProperty property should not be an extended or modified version of the on-screen label because the inconsistency between the name and the label can cause confusion among client applications and users.

When the corresponding label text is not visible on screen, or when it is replaced by graphics, alternative text should be chosen. The alternative text should be concise, intuitive, and localized to the application UI language, or to the operating system default UI language. The alternative text should not be a detailed description of the visual details, but a concise description of the UI function or feature as if it were labeled by simple text. For example, the Windows Start menu button is named "Start" (button) instead of "Windows Logo on blue round sphere graphics" (button). For more information, see Creating Text Equivalents for Images.

When a UI label uses text graphics (for example, using ">>" for a button that adds an item from left to right), the NameProperty property should be overridden by an appropriate text alternative (for example, "Add"). However the practice of using text graphics as a UI label is discouraged due to both localization and accessibility concerns.

The NameProperty property must not include the control role or type information, such as "button" or "list"; otherwise, it will conflict with the text from the LocalizedControlTypeProperty property when these two properties are appended (many existing assistive technologies do this).

The NameProperty property cannot be used as a unique identifier among siblings. However, as long as it is consistent with the UI presentation, the same NameProperty value can be supported among peers. For test automation, the clients should consider using the AutomationIdProperty or RawElementProviderRuntimeId property.

Text controls do not always have to have the NameProperty property be identical to the text that is displayed within the control, so long as the Text pattern is also supported.

PositionInSetProperty PositionInSetProperty PositionInSetProperty PositionInSetProperty

Gets the identifier for the PositionInSet attached property, which is a 1-based integer associated with an automation element.

public static DependencyProperty PositionInSetProperty { get; }public static DependencyProperty PositionInSetProperty { get; }Public Static ReadOnly Property PositionInSetProperty As DependencyPropertypublic static DependencyProperty PositionInSetProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the PositionInSet attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

PositionInSet describes the ordinal location of the element within a set of elements which are considered to be siblings.

PositionInSet works in coordination with the SizeOfSet property to describe the ordinal location in the set.

SizeOfSetProperty SizeOfSetProperty SizeOfSetProperty SizeOfSetProperty

Gets the identifier for the attached property.

public static DependencyProperty SizeOfSetProperty { get; }public static DependencyProperty SizeOfSetProperty { get; }Public Static ReadOnly Property SizeOfSetProperty As DependencyPropertypublic static DependencyProperty SizeOfSetProperty { get; }
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the attached property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Methods

GetAcceleratorKey(DependencyObject) GetAcceleratorKey(DependencyObject) GetAcceleratorKey(DependencyObject) GetAcceleratorKey(DependencyObject)

Gets the value of the AcceleratorKeyProperty attached property for the specified DependencyObject.

public static string GetAcceleratorKey(DependencyObject element)public static string GetAcceleratorKey(DependencyObject element)Public Static Function GetAcceleratorKey(element As DependencyObject) As stringpublic static string GetAcceleratorKey(DependencyObject element)
Parameters
Returns
string string string

The accelerator key, as a string.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetAccessibilityView(DependencyObject) GetAccessibilityView(DependencyObject) GetAccessibilityView(DependencyObject) GetAccessibilityView(DependencyObject)

Gets the value of the AccessibilityViewProperty attached property for the specified DependencyObject.

public static AccessibilityView GetAccessibilityView(DependencyObject element)public static AccessibilityView GetAccessibilityView(DependencyObject element)Public Static Function GetAccessibilityView(element As DependencyObject) As AccessibilityViewpublic static AccessibilityView GetAccessibilityView(DependencyObject element)
Parameters
Returns

The accessibility view setting, as a value of the enumeration.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetAccessKey(DependencyObject) GetAccessKey(DependencyObject) GetAccessKey(DependencyObject) GetAccessKey(DependencyObject)

Gets the value of the AccessKeyProperty attached property for the specified DependencyObject.

public static string GetAccessKey(DependencyObject element)public static string GetAccessKey(DependencyObject element)Public Static Function GetAccessKey(element As DependencyObject) As stringpublic static string GetAccessKey(DependencyObject element)
Parameters
Returns
string string string

The access key, as a string.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetAnnotations(DependencyObject) GetAnnotations(DependencyObject) GetAnnotations(DependencyObject) GetAnnotations(DependencyObject)

Gets the value of the property for the specified .

public static IVector<AutomationAnnotation> GetAnnotations(DependencyObject element)public static IVector<AutomationAnnotation> GetAnnotations(DependencyObject element)Public Static Function GetAnnotations(element As DependencyObject) As IVector( Of AutomationAnnotation )public static IVector<AutomationAnnotation> GetAnnotations(DependencyObject element)
Parameters
Returns

The value of the property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetAutomationId(DependencyObject) GetAutomationId(DependencyObject) GetAutomationId(DependencyObject) GetAutomationId(DependencyObject)

Gets the value of the AutomationIdProperty attached property for the specified DependencyObject.

public static string GetAutomationId(DependencyObject element)public static string GetAutomationId(DependencyObject element)Public Static Function GetAutomationId(element As DependencyObject) As stringpublic static string GetAutomationId(DependencyObject element)
Parameters
Returns
string string string

The UI Automation identifier for the specified element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetControlledPeers(DependencyObject) GetControlledPeers(DependencyObject) GetControlledPeers(DependencyObject) GetControlledPeers(DependencyObject)

A static utility method that retrieves the list of controlled peers from a target owner.

public static IVector<UIElement> GetControlledPeers(DependencyObject element)public static IVector<UIElement> GetControlledPeers(DependencyObject element)Public Static Function GetControlledPeers(element As DependencyObject) As IVector( Of UIElement )public static IVector<UIElement> GetControlledPeers(DependencyObject element)
Parameters
element
DependencyObject DependencyObject DependencyObject

The owner object to retrieve controlled peers from.

Returns

A list containing the peers that the target element controls.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Examining controlled peers is an advanced scenario that most peer implementations won't need to use.

This identifier is commonly used for Auto-suggest accessibility.

GetCulture(DependencyObject) GetCulture(DependencyObject) GetCulture(DependencyObject) GetCulture(DependencyObject)

Prerelease. Gets the value of the CultureProperty attached property for the specified DependencyObject.

public static int GetCulture(DependencyObject element)public static int GetCulture(DependencyObject element)Public Static Function GetCulture(element As DependencyObject) As intpublic static int GetCulture(DependencyObject element)
Parameters
Returns
int int int

The value of the culture property for the specified element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetDescribedBy(DependencyObject) GetDescribedBy(DependencyObject) GetDescribedBy(DependencyObject) GetDescribedBy(DependencyObject)

Gets a collection of elements that provide more information about the specified automation element.

public static IVector<DependencyObject> GetDescribedBy(DependencyObject element)public static IVector<DependencyObject> GetDescribedBy(DependencyObject element)Public Static Function GetDescribedBy(element As DependencyObject) As IVector( Of DependencyObject )public static IVector<DependencyObject> GetDescribedBy(DependencyObject element)
Parameters
element
DependencyObject DependencyObject DependencyObject

The automation element for which to get the described by collection.

Returns

A collection of elements that provide more information about the automation element specified by the element parameter.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The described by collection is used when an automation element is explained by another segment of the application UI. For example, the collection can contain a text element of "2,529 items in 85 groups, 10 items selected" from a complex custom list object. Instead of using the object model for clients to digest similar information, the described by collection can offer quick access to UI elements that may already offer useful end-user information describing the UI element.

GetFlowsFrom(DependencyObject) GetFlowsFrom(DependencyObject) GetFlowsFrom(DependencyObject) GetFlowsFrom(DependencyObject)

Gets a list of automation elements that suggests the reading order before the specified automation element.

public static IVector<DependencyObject> GetFlowsFrom(DependencyObject element)public static IVector<DependencyObject> GetFlowsFrom(DependencyObject element)Public Static Function GetFlowsFrom(element As DependencyObject) As IVector( Of DependencyObject )public static IVector<DependencyObject> GetFlowsFrom(DependencyObject element)
Parameters
element
DependencyObject DependencyObject DependencyObject

The element for which to get the preceding reading order elements.

Returns

A list of automation elements that suggests the reading order before the automation element specified by the element parameter.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetFlowsTo(DependencyObject) GetFlowsTo(DependencyObject) GetFlowsTo(DependencyObject) GetFlowsTo(DependencyObject)

Gets a list of automation elements that suggests the reading order after the specified automation element.

public static IVector<DependencyObject> GetFlowsTo(DependencyObject element)public static IVector<DependencyObject> GetFlowsTo(DependencyObject element)Public Static Function GetFlowsTo(element As DependencyObject) As IVector( Of DependencyObject )public static IVector<DependencyObject> GetFlowsTo(DependencyObject element)
Parameters
element
DependencyObject DependencyObject DependencyObject

The element for which to get the following reading order elements.

Returns

A list of automation elements that suggests the reading order after the automation element specified by the element parameter.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetFullDescription(DependencyObject) GetFullDescription(DependencyObject) GetFullDescription(DependencyObject) GetFullDescription(DependencyObject)

Gets a localized string that describes the visual appearance or contents of the specified DependencyObject.

public static string GetFullDescription(DependencyObject element)public static string GetFullDescription(DependencyObject element)Public Static Function GetFullDescription(element As DependencyObject) As stringpublic static string GetFullDescription(DependencyObject element)
Parameters
element
DependencyObject DependencyObject DependencyObject

The object for which to get the full description.

Returns
string string string

A localized string that describes the visual appearance or contents of the object specified in the element parameter.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetHelpText(DependencyObject) GetHelpText(DependencyObject) GetHelpText(DependencyObject) GetHelpText(DependencyObject)

Gets the value of the HelpTextProperty attached property for the specified DependencyObject.

public static string GetHelpText(DependencyObject element)public static string GetHelpText(DependencyObject element)Public Static Function GetHelpText(element As DependencyObject) As stringpublic static string GetHelpText(DependencyObject element)
Parameters
Returns
string string string

The help text for the specified element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetIsDataValidForForm(DependencyObject) GetIsDataValidForForm(DependencyObject) GetIsDataValidForForm(DependencyObject) GetIsDataValidForForm(DependencyObject)

Gets a Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the specified element.

public static bool GetIsDataValidForForm(DependencyObject element)public static bool GetIsDataValidForForm(DependencyObject element)Public Static Function GetIsDataValidForForm(element As DependencyObject) As boolpublic static bool GetIsDataValidForForm(DependencyObject element)
Parameters
element
DependencyObject DependencyObject DependencyObject

The element for which to get data validation.

Returns
bool bool bool

A Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the object specified by the element parameter.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetIsPeripheral(DependencyObject) GetIsPeripheral(DependencyObject) GetIsPeripheral(DependencyObject) GetIsPeripheral(DependencyObject)

Gets a Boolean value that indicates whether the specified element represents peripheral UI.

public static bool GetIsPeripheral(DependencyObject element)public static bool GetIsPeripheral(DependencyObject element)Public Static Function GetIsPeripheral(element As DependencyObject) As boolpublic static bool GetIsPeripheral(DependencyObject element)
Parameters
element
DependencyObject DependencyObject DependencyObject

The element to check for peripheral data.

Returns
bool bool bool

A Boolean value that indicates whether the DependencyObject specified by the element parameter represents peripheral UI.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetIsRequiredForForm(DependencyObject) GetIsRequiredForForm(DependencyObject) GetIsRequiredForForm(DependencyObject) GetIsRequiredForForm(DependencyObject)

Gets the value of the IsRequiredForFormProperty attached property for the specified DependencyObject.

public static bool GetIsRequiredForForm(DependencyObject element)public static bool GetIsRequiredForForm(DependencyObject element)Public Static Function GetIsRequiredForForm(element As DependencyObject) As boolpublic static bool GetIsRequiredForForm(DependencyObject element)
Parameters
Returns
bool bool bool

true if the specified element is required for completion of a form; otherwise, false.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetItemStatus(DependencyObject) GetItemStatus(DependencyObject) GetItemStatus(DependencyObject) GetItemStatus(DependencyObject)

Gets the value of the ItemStatusProperty attached property for the specified DependencyObject.

public static string GetItemStatus(DependencyObject element)public static string GetItemStatus(DependencyObject element)Public Static Function GetItemStatus(element As DependencyObject) As stringpublic static string GetItemStatus(DependencyObject element)
Parameters
Returns
string string string

The item status of the element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetItemType(DependencyObject) GetItemType(DependencyObject) GetItemType(DependencyObject) GetItemType(DependencyObject)

Gets the value of the ItemTypeProperty attached property for the specified DependencyObject.

public static string GetItemType(DependencyObject element)public static string GetItemType(DependencyObject element)Public Static Function GetItemType(element As DependencyObject) As stringpublic static string GetItemType(DependencyObject element)
Parameters
Returns
string string string

The item type of the element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetLabeledBy(DependencyObject) GetLabeledBy(DependencyObject) GetLabeledBy(DependencyObject) GetLabeledBy(DependencyObject)

Gets the value of the LabeledByProperty attached property for the specified DependencyObject.

public static UIElement GetLabeledBy(DependencyObject element)public static UIElement GetLabeledBy(DependencyObject element)Public Static Function GetLabeledBy(element As DependencyObject) As UIElementpublic static UIElement GetLabeledBy(DependencyObject element)
Parameters
Returns

The element that is targeted by the label.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetLandmarkType(DependencyObject) GetLandmarkType(DependencyObject) GetLandmarkType(DependencyObject) GetLandmarkType(DependencyObject)

Gets the value of the landmark type attached property for the specified DependencyObject.

public static AutomationLandmarkType GetLandmarkType(DependencyObject element)public static AutomationLandmarkType GetLandmarkType(DependencyObject element)Public Static Function GetLandmarkType(element As DependencyObject) As AutomationLandmarkTypepublic static AutomationLandmarkType GetLandmarkType(DependencyObject element)
Parameters
Returns
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetLevel(DependencyObject) GetLevel(DependencyObject) GetLevel(DependencyObject) GetLevel(DependencyObject)

Gets the value of the property for the specified .

public static int GetLevel(DependencyObject element)public static int GetLevel(DependencyObject element)Public Static Function GetLevel(element As DependencyObject) As intpublic static int GetLevel(DependencyObject element)
Parameters
Returns
int int int

The value of the property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetLiveSetting(DependencyObject) GetLiveSetting(DependencyObject) GetLiveSetting(DependencyObject) GetLiveSetting(DependencyObject)

Gets the value of the LiveSettingProperty attached property for the specified DependencyObject.

public static AutomationLiveSetting GetLiveSetting(DependencyObject element)public static AutomationLiveSetting GetLiveSetting(DependencyObject element)Public Static Function GetLiveSetting(element As DependencyObject) As AutomationLiveSettingpublic static AutomationLiveSetting GetLiveSetting(DependencyObject element)
Parameters
Returns

The live setting value for the specified element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetLocalizedControlType(DependencyObject) GetLocalizedControlType(DependencyObject) GetLocalizedControlType(DependencyObject) GetLocalizedControlType(DependencyObject)

Gets a localized string that indicates the type of the specified control.

public static string GetLocalizedControlType(DependencyObject element)public static string GetLocalizedControlType(DependencyObject element)Public Static Function GetLocalizedControlType(element As DependencyObject) As stringpublic static string GetLocalizedControlType(DependencyObject element)
Parameters
element
DependencyObject DependencyObject DependencyObject

The control for which to retrieve the type.

Returns
string string string

A localized string that indicates the type of the control specified by the element parameter.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Provides a mechanism to alter the control type read by Narrator. This is helpful in describing custom UI as "Menu" or "Button" where default controls are not used or composite UI built from common controls is used to create new functionality.

GetLocalizedLandmarkType(DependencyObject) GetLocalizedLandmarkType(DependencyObject) GetLocalizedLandmarkType(DependencyObject) GetLocalizedLandmarkType(DependencyObject)

Gets the value of the localized landmark type attached property for the specified DependencyObject.

public static string GetLocalizedLandmarkType(DependencyObject element)public static string GetLocalizedLandmarkType(DependencyObject element)Public Static Function GetLocalizedLandmarkType(element As DependencyObject) As stringpublic static string GetLocalizedLandmarkType(DependencyObject element)
Parameters
Returns
string string string

The localized string defining the landmark type of the element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetName(DependencyObject) GetName(DependencyObject) GetName(DependencyObject) GetName(DependencyObject)

Gets the value of the NameProperty attached property for the specified DependencyObject.

public static string GetName(DependencyObject element)public static string GetName(DependencyObject element)Public Static Function GetName(element As DependencyObject) As stringpublic static string GetName(DependencyObject element)
Parameters
Returns
string string string

The name of the specified element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetPositionInSet(DependencyObject) GetPositionInSet(DependencyObject) GetPositionInSet(DependencyObject) GetPositionInSet(DependencyObject)

Gets the value of the property for the specified .

public static int GetPositionInSet(DependencyObject element)public static int GetPositionInSet(DependencyObject element)Public Static Function GetPositionInSet(element As DependencyObject) As intpublic static int GetPositionInSet(DependencyObject element)
Parameters
Returns
int int int

The value of the property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetSizeOfSet(DependencyObject) GetSizeOfSet(DependencyObject) GetSizeOfSet(DependencyObject) GetSizeOfSet(DependencyObject)

Gets the value of the property for the specified .

public static int GetSizeOfSet(DependencyObject element)public static int GetSizeOfSet(DependencyObject element)Public Static Function GetSizeOfSet(element As DependencyObject) As intpublic static int GetSizeOfSet(DependencyObject element)
Parameters
Returns
int int int

The value of the property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetAcceleratorKey(DependencyObject, String) SetAcceleratorKey(DependencyObject, String) SetAcceleratorKey(DependencyObject, String) SetAcceleratorKey(DependencyObject, String)

Sets the value of the AcceleratorKeyProperty attached property for the specified DependencyObject.

public static void SetAcceleratorKey(DependencyObject element, String value)public static void SetAcceleratorKey(DependencyObject element, String value)Public Static Function SetAcceleratorKey(element As DependencyObject, value As String) As voidpublic static void SetAcceleratorKey(DependencyObject element, String value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

value
System.String System.String System.String

The accelerator key value to set.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetAccessibilityView(DependencyObject, AccessibilityView) SetAccessibilityView(DependencyObject, AccessibilityView) SetAccessibilityView(DependencyObject, AccessibilityView) SetAccessibilityView(DependencyObject, AccessibilityView)

Sets the value of the AccessibilityViewProperty attached property for the specified DependencyObject.

public static void SetAccessibilityView(DependencyObject element, AccessibilityView value)public static void SetAccessibilityView(DependencyObject element, AccessibilityView value)Public Static Function SetAccessibilityView(element As DependencyObject, value As AccessibilityView) As voidpublic static void SetAccessibilityView(DependencyObject element, AccessibilityView value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject to set the attached property on.

value
AccessibilityView AccessibilityView AccessibilityView

The enumeration value to set

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetAccessKey(DependencyObject, String) SetAccessKey(DependencyObject, String) SetAccessKey(DependencyObject, String) SetAccessKey(DependencyObject, String)

Sets the value of the AccessKeyProperty attached property for the specified DependencyObject.

public static void SetAccessKey(DependencyObject element, String value)public static void SetAccessKey(DependencyObject element, String value)Public Static Function SetAccessKey(element As DependencyObject, value As String) As voidpublic static void SetAccessKey(DependencyObject element, String value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

value
System.String System.String System.String

The access key value to set.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetAutomationId(DependencyObject, String) SetAutomationId(DependencyObject, String) SetAutomationId(DependencyObject, String) SetAutomationId(DependencyObject, String)

Sets the value of the AutomationIdProperty attached property for the specified DependencyObject.

public static void SetAutomationId(DependencyObject element, String value)public static void SetAutomationId(DependencyObject element, String value)Public Static Function SetAutomationId(element As DependencyObject, value As String) As voidpublic static void SetAutomationId(DependencyObject element, String value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

value
System.String System.String System.String

The UI Automation identifier value to set.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetCulture(DependencyObject, Int32) SetCulture(DependencyObject, Int32) SetCulture(DependencyObject, Int32) SetCulture(DependencyObject, Int32)

Prerelease. Sets the value of the CultureProperty attached property for the specified DependencyObject.

public static void SetCulture(DependencyObject element, Int32 value)public static void SetCulture(DependencyObject element, Int32 value)Public Static Function SetCulture(element As DependencyObject, value As Int32) As voidpublic static void SetCulture(DependencyObject element, Int32 value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the culture property.

value
System.Int32 System.Int32 System.Int32

The value of the culture property to set for the specified element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetFullDescription(DependencyObject, String) SetFullDescription(DependencyObject, String) SetFullDescription(DependencyObject, String) SetFullDescription(DependencyObject, String)

Sets a localized string that describes the visual appearance or contents of the specified DependencyObject.

public static void SetFullDescription(DependencyObject element, String value)public static void SetFullDescription(DependencyObject element, String value)Public Static Function SetFullDescription(element As DependencyObject, value As String) As voidpublic static void SetFullDescription(DependencyObject element, String value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The object for which to set the full description.

value
System.String System.String System.String

The localized full description of the object specified in the element parameter.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetHelpText(DependencyObject, String) SetHelpText(DependencyObject, String) SetHelpText(DependencyObject, String) SetHelpText(DependencyObject, String)

Sets the value of the HelpTextProperty attached property for the specified DependencyObject.

public static void SetHelpText(DependencyObject element, String value)public static void SetHelpText(DependencyObject element, String value)Public Static Function SetHelpText(element As DependencyObject, value As String) As voidpublic static void SetHelpText(DependencyObject element, String value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

value
System.String System.String System.String

The help text.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetIsDataValidForForm(DependencyObject, Boolean) SetIsDataValidForForm(DependencyObject, Boolean) SetIsDataValidForForm(DependencyObject, Boolean) SetIsDataValidForForm(DependencyObject, Boolean)

Sets a Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the specified element.

public static void SetIsDataValidForForm(DependencyObject element, Boolean value)public static void SetIsDataValidForForm(DependencyObject element, Boolean value)Public Static Function SetIsDataValidForForm(element As DependencyObject, value As Boolean) As voidpublic static void SetIsDataValidForForm(DependencyObject element, Boolean value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The element for which to set data validation.

value
System.Boolean System.Boolean System.Boolean

A Boolean value that indicates whether the entered or selected data is valid for the form.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetIsPeripheral(DependencyObject, Boolean) SetIsPeripheral(DependencyObject, Boolean) SetIsPeripheral(DependencyObject, Boolean) SetIsPeripheral(DependencyObject, Boolean)

Sets a Boolean value that indicates whether the specified element represents peripheral UI.

public static void SetIsPeripheral(DependencyObject element, Boolean value)public static void SetIsPeripheral(DependencyObject element, Boolean value)Public Static Function SetIsPeripheral(element As DependencyObject, value As Boolean) As voidpublic static void SetIsPeripheral(DependencyObject element, Boolean value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The element for which to set peripheral data.

value
System.Boolean System.Boolean System.Boolean

A Boolean value that indicates whether the DependencyObject specified by the element parameter represents peripheral UI.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetIsRequiredForForm(DependencyObject, Boolean) SetIsRequiredForForm(DependencyObject, Boolean) SetIsRequiredForForm(DependencyObject, Boolean) SetIsRequiredForForm(DependencyObject, Boolean)

Sets the value of the IsRequiredForFormProperty attached property for the specified DependencyObject.

public static void SetIsRequiredForForm(DependencyObject element, Boolean value)public static void SetIsRequiredForForm(DependencyObject element, Boolean value)Public Static Function SetIsRequiredForForm(element As DependencyObject, value As Boolean) As voidpublic static void SetIsRequiredForForm(DependencyObject element, Boolean value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

value
System.Boolean System.Boolean System.Boolean

true to specify that the element is required to be filled out on a form; otherwise, false.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetItemStatus(DependencyObject, String) SetItemStatus(DependencyObject, String) SetItemStatus(DependencyObject, String) SetItemStatus(DependencyObject, String)

Sets the value of the ItemStatusProperty attached property for the specified DependencyObject.

public static void SetItemStatus(DependencyObject element, String value)public static void SetItemStatus(DependencyObject element, String value)Public Static Function SetItemStatus(element As DependencyObject, value As String) As voidpublic static void SetItemStatus(DependencyObject element, String value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

value
System.String System.String System.String

The item status.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetItemType(DependencyObject, String) SetItemType(DependencyObject, String) SetItemType(DependencyObject, String) SetItemType(DependencyObject, String)

Sets the value of the ItemTypeProperty attached property for the specified DependencyObject.

public static void SetItemType(DependencyObject element, String value)public static void SetItemType(DependencyObject element, String value)Public Static Function SetItemType(element As DependencyObject, value As String) As voidpublic static void SetItemType(DependencyObject element, String value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

value
System.String System.String System.String

The item type.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetLabeledBy(DependencyObject, UIElement) SetLabeledBy(DependencyObject, UIElement) SetLabeledBy(DependencyObject, UIElement) SetLabeledBy(DependencyObject, UIElement)

Sets the value of the LabeledByProperty attached property for the specified DependencyObject.

public static void SetLabeledBy(DependencyObject element, UIElement value)public static void SetLabeledBy(DependencyObject element, UIElement value)Public Static Function SetLabeledBy(element As DependencyObject, value As UIElement) As voidpublic static void SetLabeledBy(DependencyObject element, UIElement value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

value
UIElement UIElement UIElement

The UI element that represents the label for element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetLandmarkType(DependencyObject, AutomationLandmarkType) SetLandmarkType(DependencyObject, AutomationLandmarkType) SetLandmarkType(DependencyObject, AutomationLandmarkType) SetLandmarkType(DependencyObject, AutomationLandmarkType)

Sets the value of the landmark type attached property for the specified DependencyObject.

public static void SetLandmarkType(DependencyObject element, AutomationLandmarkType value)public static void SetLandmarkType(DependencyObject element, AutomationLandmarkType value)Public Static Function SetLandmarkType(element As DependencyObject, value As AutomationLandmarkType) As voidpublic static void SetLandmarkType(DependencyObject element, AutomationLandmarkType value)
Parameters
value
AutomationLandmarkType AutomationLandmarkType AutomationLandmarkType

The value of the landmark type property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetLevel(DependencyObject, Int32) SetLevel(DependencyObject, Int32) SetLevel(DependencyObject, Int32) SetLevel(DependencyObject, Int32)

Sets the value of the property for the specified .

public static void SetLevel(DependencyObject element, Int32 value)public static void SetLevel(DependencyObject element, Int32 value)Public Static Function SetLevel(element As DependencyObject, value As Int32) As voidpublic static void SetLevel(DependencyObject element, Int32 value)
Parameters
value
System.Int32 System.Int32 System.Int32

The value of the property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetLiveSetting(DependencyObject, AutomationLiveSetting) SetLiveSetting(DependencyObject, AutomationLiveSetting) SetLiveSetting(DependencyObject, AutomationLiveSetting) SetLiveSetting(DependencyObject, AutomationLiveSetting)

Sets the value of the LiveSettingProperty attached property for the specified DependencyObject.

public static void SetLiveSetting(DependencyObject element, AutomationLiveSetting value)public static void SetLiveSetting(DependencyObject element, AutomationLiveSetting value)Public Static Function SetLiveSetting(element As DependencyObject, value As AutomationLiveSetting) As voidpublic static void SetLiveSetting(DependencyObject element, AutomationLiveSetting value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetLocalizedControlType(DependencyObject, String) SetLocalizedControlType(DependencyObject, String) SetLocalizedControlType(DependencyObject, String) SetLocalizedControlType(DependencyObject, String)

Sets a localized string that indicates the type of the specified control.

public static void SetLocalizedControlType(DependencyObject element, String value)public static void SetLocalizedControlType(DependencyObject element, String value)Public Static Function SetLocalizedControlType(element As DependencyObject, value As String) As voidpublic static void SetLocalizedControlType(DependencyObject element, String value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The control for which to set the type.

value
System.String System.String System.String

A localized string that indicates the type of the control specified by the element parameter.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Provides a mechanism to alter the control type read by Narrator. This is helpful in describing custom UI as "Menu" or "Button" where default controls are not used or composite UI built from common controls is used to create new functionality.

SetLocalizedLandmarkType(DependencyObject, String) SetLocalizedLandmarkType(DependencyObject, String) SetLocalizedLandmarkType(DependencyObject, String) SetLocalizedLandmarkType(DependencyObject, String)

Sets the value of the localized landmark type attached property for the specified DependencyObject.

public static void SetLocalizedLandmarkType(DependencyObject element, String value)public static void SetLocalizedLandmarkType(DependencyObject element, String value)Public Static Function SetLocalizedLandmarkType(element As DependencyObject, value As String) As voidpublic static void SetLocalizedLandmarkType(DependencyObject element, String value)
Parameters
value
System.String System.String System.String

The localized string defining the landmark type of the element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetName(DependencyObject, String) SetName(DependencyObject, String) SetName(DependencyObject, String) SetName(DependencyObject, String)

Sets the value of the NameProperty attached property for the specified DependencyObject.

public static void SetName(DependencyObject element, String value)public static void SetName(DependencyObject element, String value)Public Static Function SetName(element As DependencyObject, value As String) As voidpublic static void SetName(DependencyObject element, String value)
Parameters
element
DependencyObject DependencyObject DependencyObject

The DependencyObject for which to set the property.

value
System.String System.String System.String

The object name.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetPositionInSet(DependencyObject, Int32) SetPositionInSet(DependencyObject, Int32) SetPositionInSet(DependencyObject, Int32) SetPositionInSet(DependencyObject, Int32)

Sets the value of the property for the specified .

public static void SetPositionInSet(DependencyObject element, Int32 value)public static void SetPositionInSet(DependencyObject element, Int32 value)Public Static Function SetPositionInSet(element As DependencyObject, value As Int32) As voidpublic static void SetPositionInSet(DependencyObject element, Int32 value)
Parameters
value
System.Int32 System.Int32 System.Int32

The value of the property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetSizeOfSet(DependencyObject, Int32) SetSizeOfSet(DependencyObject, Int32) SetSizeOfSet(DependencyObject, Int32) SetSizeOfSet(DependencyObject, Int32)

Sets the value of the AutomationProperties.SizeOfSet property for the specified .

public static void SetSizeOfSet(DependencyObject element, Int32 value)public static void SetSizeOfSet(DependencyObject element, Int32 value)Public Static Function SetSizeOfSet(element As DependencyObject, value As Int32) As voidpublic static void SetSizeOfSet(DependencyObject element, Int32 value)
Parameters
value
System.Int32 System.Int32 System.Int32

The value of the property.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)