ISelectionItemProvider.RemoveFromSelection Method

Definition

Namespace:

System.Windows.Automation.Provider

Assembly:

UIAutomationProvider.dll

Removes the current element from the collection of selected items.

public:
 void RemoveFromSelection();

public void RemoveFromSelection ();

abstract member RemoveFromSelection : unit -> unit

Public Sub RemoveFromSelection ()

Examples

The following example code removes the item from a collection of selected items.

/// <summary>
/// Removes the item from the selection in list boxes that support 
/// multiple selection or no selection at all.
/// </summary>
/// <remarks>
/// selectedItems is the collection of selected ListItems.
/// </remarks>
public void RemoveFromSelection()
{
    // Return if the item is already selected.
    if (((ISelectionItemProvider)this).IsSelected)
        return;
    if (((ISelectionProvider)this).IsSelectionRequired & selectedItems.Count <= 0)
        throw new InvalidOperationException("Operation cannot be performed.");

    selectedItems.Remove(this);
    // TODO: Update UI.
}

''' <summary>
''' Removes the item from the selection in list boxes that support 
''' multiple selection or no selection at all.
''' </summary>
''' <remarks>
''' selectedItems is the collection of selected ListItems.
''' </remarks>
Public Sub RemoveFromSelection() Implements ISelectionItemProvider.RemoveFromSelection
    ' Return if the item is already selected.
    If (CType(Me, ISelectionItemProvider)).IsSelected Then
        Return
    End If
    If (CType(Me, ISelectionProvider)).IsSelectionRequired And selectedItems.Count <= 0 Then
        Throw New InvalidOperationException("Operation cannot be performed.")
    End If

    selectedItems.Remove(Me)
    ' TODO: Update UI.
End Sub

/// <summary>
/// Specifies whether the item is selected.
/// </summary>
/// <remarks>
/// selectedItems is the collection of selected ListItems.
/// </remarks>
public bool IsSelected
{
    get
    {
        return selectedItems.Contains(this);
    }
}

''' <summary>
''' Specifies whether the item is selected.
''' </summary>
''' <remarks>
''' selectedItems is the collection of selected ListItems.
''' </remarks>
Public ReadOnly Property IsSelected() As Boolean Implements ISelectionItemProvider.IsSelected
    Get
        Return selectedItems.Contains(Me)
    End Get
End Property

Remarks

Send an ElementRemovedFromSelectionEvent as appropriate.

Note

This rule does not depend on whether the container allows single or multiple selections, or on what method was used to change the selection. Only the result matters.

See also

• Implementing the UI Automation SelectionItem Control Pattern
• Fragment Provider Sample