SelectionPattern.IsSelectionRequiredProperty Field

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Identifies the IsSelectionRequired property.

public: static initonly System::Windows::Automation::AutomationProperty ^ IsSelectionRequiredProperty;

public static readonly System.Windows.Automation.AutomationProperty IsSelectionRequiredProperty;

 staticval mutable IsSelectionRequiredProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly IsSelectionRequiredProperty As AutomationProperty 

Field Value

AutomationProperty

Examples

In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions.

///--------------------------------------------------------------------
/// <summary>
/// Finds all automation elements that satisfy 
/// the specified condition(s).
/// </summary>
/// <param name="rootElement">
/// The automation element from which to start searching.
/// </param>
/// <returns>
/// A collection of automation elements satisfying 
/// the specified condition(s).
/// </returns>
///--------------------------------------------------------------------
private AutomationElementCollection FindAutomationElement(
    AutomationElement rootElement)
{
    if (rootElement == null)
    {
        throw new ArgumentException("Root element cannot be null.");
    }

    PropertyCondition conditionCanSelectMultiple =
        new PropertyCondition(
        SelectionPattern.CanSelectMultipleProperty, true);

    PropertyCondition conditionIsSelectionRequired =
        new PropertyCondition(
        SelectionPattern.IsSelectionRequiredProperty, false);

    // Use any combination of the preceding condtions to 
    // find the control(s) of interest
    Condition condition = new AndCondition(
        conditionCanSelectMultiple,
        conditionIsSelectionRequired);

    return rootElement.FindAll(TreeScope.Descendants, condition);
}

'''--------------------------------------------------------------------
''' <summary>
''' Finds all automation elements that satisfy 
''' the specified condition(s).
''' </summary>
''' <param name="rootElement">
''' The automation element from which to start searching.
''' </param>
''' <returns>
''' A collection of automation elements satisfying 
''' the specified condition(s).
''' </returns>
'''--------------------------------------------------------------------
Private Function FindAutomationElement( _
ByVal rootElement As AutomationElement) As AutomationElementCollection
    If rootElement Is Nothing Then
        Throw New ArgumentException("Root element cannot be null.")
    End If

    Dim conditionCanSelectMultiple As New PropertyCondition( _
    SelectionPattern.CanSelectMultipleProperty, True)

    Dim conditionIsSelectionRequired As New PropertyCondition( _
    SelectionPattern.IsSelectionRequiredProperty, False)

    ' Use any combination of the preceding condtions to 
    ' find the control(s) of interest
    Dim condition As New AndCondition( _
    conditionCanSelectMultiple, conditionIsSelectionRequired)

    Return rootElement.FindAll(TreeScope.Descendants, condition)
End Function 'FindAutomationElement

Remarks

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