This documentation is archived and is not being maintained.

SelectionItemPattern.RemoveFromSelection Method

Removes the current element from the collection of selected items.

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

public void RemoveFromSelection()

ExceptionCondition
InvalidOperationException

An attempt is made to remove a selection from a selection container where one item is selected and IsSelectionRequiredProperty = true.

The following example shows how to remove an element from the collection of currently selected items.


///--------------------------------------------------------------------
/// <summary>
/// Retrieves the selection container for a selection item.
/// </summary>
/// <param name="selectionItem">
/// An automation element that supports SelectionItemPattern.
/// </param>
///--------------------------------------------------------------------
private AutomationElement GetSelectionItemContainer(
    AutomationElement selectionItem)
{
    // Selection item cannot be null
    if (selectionItem == null)
    {
        throw new ArgumentException();
    }

    SelectionItemPattern selectionItemPattern = 
        selectionItem.GetCurrentPattern(SelectionItemPattern.Pattern) 
        as SelectionItemPattern;
    if (selectionItemPattern == null)
    {
        return null;
    }
    else
    {
        return selectionItemPattern.Current.SelectionContainer; 
    }
}


...


///--------------------------------------------------------------------
/// <summary>
/// Attempts to remove the current item from a collection 
/// of selected items. 
/// </summary>
/// <param name="selectionItem">
/// An automation element that supports SelectionItemPattern.
/// </param>
///--------------------------------------------------------------------
private void RemoveItemFromSelection(AutomationElement selectionItem)
{
    if (selectionItem == null)
    {
        throw new ArgumentNullException(
            "Argument cannot be null or empty.");
    }

    AutomationElement selectionContainer =
        GetSelectionItemContainer(selectionItem);

    // Selection container cannot be null
    if (selectionContainer == null)
    {
        throw new ElementNotAvailableException();
    }

    SelectionPattern selectionPattern =
        selectionContainer.GetCurrentPattern(SelectionPattern.Pattern)
        as SelectionPattern;

    if (selectionPattern == null)
    {
        return;
    }

    // Check if a selection is required
    if (selectionPattern.Current.IsSelectionRequired && 
        (selectionPattern.Current.GetSelection().GetLength(0) <= 1))
    {
        return;
    }

    SelectionItemPattern selectionItemPattern =
        selectionItem.GetCurrentPattern(
        SelectionItemPattern.Pattern)
        as SelectionItemPattern;
    if ((selectionItemPattern != null) && 
        selectionItemPattern.Current.IsSelected)
    {
        try
        {
            selectionItemPattern.RemoveFromSelection();
        }
        catch (InvalidOperationException)
        {
            // Unable to remove from selection
            return;
        }
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: