Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

AutomationEvent Class

Identifies a UI Automation event.

System.Object
  System.Windows.Automation.AutomationIdentifier
    System.Windows.Automation.AutomationEvent

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

'Declaration
Public Class AutomationEvent _
	Inherits AutomationIdentifier

The AutomationEvent type exposes the following members.

  NameDescription
Public propertyIdGets the underlying numerical identifier. (Inherited from AutomationIdentifier.)
Public propertyProgrammaticNameGets the registered programmatic name. (Inherited from AutomationIdentifier.)
Top

  NameDescription
Public methodCompareToCompares this AutomationIdentifier with another AutomationIdentifier. (Inherited from AutomationIdentifier.)
Public methodEqualsReturns a value indicating whether the supplied AutomationIdentifier is equivalent to this AutomationIdentifier. (Inherited from AutomationIdentifier.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this UI Automation identifier. (Inherited from AutomationIdentifier.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodStatic memberLookupByIdRetrieves an AutomationEvent that encapsulates the specified numerical identifier.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Identifiers of these types are found as fields in various classes to identify events; for example, InvokedEvent. They are also found in the event arguments passed to UI Automation clients.

It is not possible to create custom events.

In the following example event handler, the AutomationEvent in the event arguments is compared with the AutomationEvent that identifies the Invoked event.


''' <summary>
''' AutomationEventHandler delegate.
''' </summary>
''' <param name="src">Object that raised the event.</param>
''' <param name="e">Event arguments.</param>
Private Sub OnUIAutomationEvent(ByVal src As Object, ByVal e As AutomationEventArgs)
    ' Make sure the element still exists. Elements such as tooltips can disappear
    ' before the event is processed.
    Dim sourceElement As AutomationElement
    Try
        sourceElement = DirectCast(src, AutomationElement)
    Catch ex As ElementNotAvailableException
        Exit Sub
    End Try
    If e.EventId Is InvokePattern.InvokedEvent Then
        ' TODO Add handling code.
    Else
    End If
    ' TODO Handle any other events that have been subscribed to.
    Console.WriteLine("Event: " & e.EventId.ProgrammaticName)
End Sub 'OnUIAutomationEvent


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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

Community Additions

Show:
© 2017 Microsoft