This documentation is archived and is not being maintained.

AutomationProperty Class

Identifies a property of an AutomationElement.

Namespace:  System.Windows.Automation
Assembly:  UIAutomationTypes (in UIAutomationTypes.dll)

'Declaration
Public Class AutomationProperty _
	Inherits AutomationIdentifier
'Usage
Dim instance As AutomationProperty

This class identifies properties, not the values of properties. Static objects of this type are found as fields of AutomationElement and control pattern classes.

The following example adds a property-changed event handler, and the handler checks the Property member of the event arguments to determine the property that has been changed.

Dim propChangeHandler As AutomationPropertyChangedEventHandler

''' <summary> 
''' Adds a handler for property-changed event; in particular, a change in the enabled state. 
''' </summary> 
''' <param name="element">The UI Automation element whose state is being monitored.</param> 
Public Sub SubscribePropertyChange(ByVal element As AutomationElement)
    propChangeHandler = _
        New AutomationPropertyChangedEventHandler(AddressOf OnPropertyChange)
    Automation.AddAutomationPropertyChangedEventHandler(element, TreeScope.Element, _
        propChangeHandler, AutomationElement.IsEnabledProperty)

End Sub 'SubscribePropertyChange



''' <summary> 
''' Handler for property changes. 
''' </summary> 
''' <param name="src">The source whose properties changed.</param> 
''' <param name="e">Event arguments.</param> 
Private Sub OnPropertyChange(ByVal src As Object, ByVal e As AutomationPropertyChangedEventArgs) 
    Dim sourceElement As AutomationElement = DirectCast(src, AutomationElement)
    If e.Property Is AutomationElement.IsEnabledProperty Then 
        Dim enabled As Boolean = CBool(e.NewValue)
        ' TODO: Do something with the new value.  
        ' The element that raised the event can be identified by its runtime ID property. 
    Else 
    End If 
 ' TODO: Handle other property-changed events. 
End Sub 'OnPropertyChange


Public Sub UnsubscribePropertyChange(ByVal element As AutomationElement)
    If (propChangeHandler IsNot Nothing) Then
        Automation.RemoveAutomationPropertyChangedEventHandler(element, propChangeHandler)
    End If 

End Sub 'UnsubscribePropertyChange

System.Object
  System.Windows.Automation.AutomationIdentifier
    System.Windows.Automation.AutomationProperty

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Show: