AutomationEvent Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Identifies a UI Automation event.

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

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

public class AutomationEvent : AutomationIdentifier

NameDescription
System_CAPS_pubpropertyId

Gets the underlying numerical identifier.(Inherited from AutomationIdentifier.)

System_CAPS_pubpropertyProgrammaticName

Gets the registered programmatic name.(Inherited from AutomationIdentifier.)

NameDescription
System_CAPS_pubmethodCompareTo(Object)

Compares this AutomationIdentifier with another AutomationIdentifier.(Inherited from AutomationIdentifier.)

System_CAPS_pubmethodEquals(Object)

Returns a value indicating whether the supplied AutomationIdentifier is equivalent to this AutomationIdentifier.(Inherited from AutomationIdentifier.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this UI Automation identifier.(Inherited from AutomationIdentifier.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticLookupById(Int32)

Retrieves an AutomationEvent that encapsulates the specified numerical identifier.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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 void OnUIAutomationEvent(object src, AutomationEventArgs e)
{
    // Make sure the element still exists. Elements such as tooltips
    // can disappear before the event is processed.
    AutomationElement sourceElement;
    try
    {
        sourceElement = src as AutomationElement;
    }
    catch (ElementNotAvailableException)
    {
        return;
    }
    if (e.EventId == InvokePattern.InvokedEvent)
    {
        // TODO Add handling code.
    }
    else
    {
        // TODO Handle any other events that have been subscribed to.
    }
}

.NET Framework
Available since 3.0

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

Return to top
Show: