SelectionItemPattern.ElementRemovedFromSelectionEvent Field

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Identifies the event raised when an item is removed from a collection of selected items.

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

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

 staticval mutable ElementRemovedFromSelectionEvent : System.Windows.Automation.AutomationEvent

Public Shared ReadOnly ElementRemovedFromSelectionEvent As AutomationEvent 

Field Value

AutomationEvent

Examples

In the following example, event listeners are declared for the SelectionItemPattern events.

///--------------------------------------------------------------------
/// <summary>
/// Subscribe to the selection item events of interest.
/// </summary>
/// <param name="selectionItem">
/// Automation element that supports SelectionItemPattern and is 
/// a child of a selection container that supports SelectionPattern
/// </param>
/// <remarks>
/// The events are raised by the SelectionItem elements, 
/// not the Selection container.
/// </remarks>
///--------------------------------------------------------------------
private void SetSelectionEventHandlers
    (AutomationElement selectionItem)
{
    AutomationEventHandler selectionHandler =
        new AutomationEventHandler(SelectionHandler);

    Automation.AddAutomationEventHandler(
        SelectionItemPattern.ElementSelectedEvent,
        selectionItem,
        TreeScope.Element,
        SelectionHandler);
    Automation.AddAutomationEventHandler(
        SelectionItemPattern.ElementAddedToSelectionEvent,
        selectionItem,
        TreeScope.Element,
        SelectionHandler);
    Automation.AddAutomationEventHandler(
        SelectionItemPattern.ElementRemovedFromSelectionEvent,
        selectionItem,
        TreeScope.Element,
        SelectionHandler);
}

private void SelectionHandler(object src, AutomationEventArgs e)
{
    // TODO: event handling
}

'''--------------------------------------------------------------------
''' <summary>
''' Subscribe to the selection item events of interest.
''' </summary>
''' <param name="selectionItem">
''' Automation element that supports SelectionItemPattern and is 
''' a child of a selection container that supports SelectionPattern
''' </param>
''' <remarks>
''' The events are raised by the SelectionItem elements, 
''' not the Selection container.
''' </remarks>
'''--------------------------------------------------------------------
Private Sub SetSelectionEventHandlers( _
ByVal selectionItem As AutomationElement)
    Dim selectionHandler As AutomationEventHandler = _
    New AutomationEventHandler(AddressOf OnSelectionHandler)

    Automation.AddAutomationEventHandler( _
    SelectionItemPattern.ElementSelectedEvent, _
    selectionItem, TreeScope.Element, selectionHandler)
    Automation.AddAutomationEventHandler( _
    SelectionItemPattern.ElementAddedToSelectionEvent, _
    selectionItem, TreeScope.Element, selectionHandler)
    Automation.AddAutomationEventHandler( _
    SelectionItemPattern.ElementRemovedFromSelectionEvent, _
    selectionItem, TreeScope.Element, selectionHandler)
End Sub


Private Sub OnSelectionHandler(ByVal src As Object, ByVal e As AutomationEventArgs)
    ' TODO: event handling
End Sub

Remarks

If the result of a RemoveFromSelection call is a single selected item, then an ElementSelectedEvent will be raised instead.

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