Export (0) Print
Expand All

AutomationElement.GetCurrentPattern Method

Retrieves the specified pattern object on this AutomationElement.

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

public Object GetCurrentPattern(
	AutomationPattern pattern
)

Parameters

pattern
Type: System.Windows.Automation.AutomationPattern

The identifier of the pattern to retrieve.

Return Value

Type: System.Object
The pattern object, if the specified pattern is currently supported by the AutomationElement.

ExceptionCondition
InvalidOperationException

The pattern is not supported by the element.

ElementNotAvailableException

The UI for the AutomationElement no longer exists.

GetCurrentPattern gets the specified pattern based on its availability at the time of the call.

For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching patterns and then retrieving them by using GetCachedPattern(Automationpattern).

The following example shows how to use this method to retrieve a SelectionItemPattern, which is then used to select an item in a list box.

/// <summary> 
/// Sets the focus to a list and selects a string item in that list. 
/// </summary> 
/// <param name="listElement">The list element.</param>
/// <param name="itemText">The text to select.</param>
/// <remarks> 
/// This deselects any currently selected items. To add the item to the current selection  
/// in a multiselect list, use AddToSelection instead of Select. 
/// </remarks> 
public void SelectListItem(AutomationElement listElement, String itemText)
{
    if ((listElement == null) || (itemText == ""))
    {
        throw new ArgumentException("Argument cannot be null or empty.");
    }
    listElement.SetFocus();
    Condition cond = new PropertyCondition(
        AutomationElement.NameProperty, itemText, PropertyConditionFlags.IgnoreCase);
    AutomationElement elementItem = listElement.FindFirst(TreeScope.Children, cond);
    if (elementItem != null)
    {
        SelectionItemPattern pattern;
        try
        {
            pattern = elementItem.GetCurrentPattern(SelectionItemPattern.Pattern) as SelectionItemPattern;
        }
        catch (InvalidOperationException ex)
        {
            Console.WriteLine(ex.Message);  // Most likely "Pattern not supported." 
            return;
        }
        pattern.Select();
    }
}
NoteNote:

For often-repeated tasks such as the one in the example, it would be more efficient to cache the pattern and use GetCachedPattern.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0

Community Additions

ADD
Show:
© 2014 Microsoft