AutomationEventArgs.EventId Property

Reference

Definition

Namespace:: System.Windows.Automation

Assembly:: UIAutomationTypes.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the event identifier.

public:
 property System::Windows::Automation::AutomationEvent ^ EventId { System::Windows::Automation::AutomationEvent ^ get(); };

public System.Windows.Automation.AutomationEvent EventId { get; }

member this.EventId : System.Windows.Automation.AutomationEvent

Public ReadOnly Property EventId As AutomationEvent

Property Value

AutomationEvent

The event identifier.

Examples

In the following example, the event handler checks the EventId of the event and handles the event accordingly.

/// <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.
    }
}

''' <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

Remarks

If a client has added event handlers for more than one event using the same AutomationEventHandler instance, EventId can be used to identify the event that the delegate should process.

Applies to

Jaa