InvokePattern.InvokedEvent Field

public: static initonly System::Windows::Automation::AutomationEvent ^ InvokedEvent;

public static readonly System.Windows.Automation.AutomationEvent InvokedEvent;

 staticval mutable InvokedEvent : System.Windows.Automation.AutomationEvent

Public Shared ReadOnly InvokedEvent As AutomationEvent 

Field Value

Examples

In the following example, the event handler identifies the event as an Invoked event by comparing the EventId in the event arguments with the InvokedEvent identifier field.

// Member variables.
AutomationElement ElementSubscribeButton;
AutomationEventHandler UIAeventHandler;

/// <summary>
/// Register an event handler for InvokedEvent on the specified element.
/// </summary>
/// <param name="elementButton">The automation element.</param>
public void SubscribeToInvoke(AutomationElement elementButton)
{
 if (elementButton != null)
 {
 Automation.AddAutomationEventHandler(InvokePattern.InvokedEvent,
 elementButton, TreeScope.Element,
 UIAeventHandler = new AutomationEventHandler(OnUIAutomationEvent));
 ElementSubscribeButton = elementButton;
 }
}

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

private void ShutdownUIA()
{
 if (UIAeventHandler != null)
 {
 Automation.RemoveAutomationEventHandler(InvokePattern.InvokedEvent,
 ElementSubscribeButton, UIAeventHandler);
 }
}

' Member variables.
Private ElementSubscribeButton As AutomationElement
Private UIAeventHandler As AutomationEventHandler


''' <summary>
''' Register an event handler for InvokedEvent on the specified element.
''' </summary>
''' <param name="elementButton">The automation element.</param>
Public Sub SubscribeToInvoke(ByVal elementButton As AutomationElement)
 If (elementButton IsNot Nothing) Then
 UIAeventHandler = New AutomationEventHandler(AddressOf OnUIAutomationEvent)
 Automation.AddAutomationEventHandler(InvokePattern.InvokedEvent, elementButton, _
 TreeScope.Element, UIAeventHandler)
 ElementSubscribeButton = elementButton
 End If

End Sub


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

Private Sub ShutdownUIA()
 If (UIAeventHandler IsNot Nothing) Then
 Automation.RemoveAutomationEventHandler(InvokePattern.InvokedEvent, ElementSubscribeButton, UIAeventHandler)
 End If

End Sub

Remarks

This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in InvokePatternIdentifiers.

The InvokedEvent identifier is passed as a parameter to AddAutomationEventHandler.

See also

• Invoke a Control Using UI Automation
• InvokePattern and ExpandCollapsePattern Menu Item Sample