Export (0) Print
Expand All

AutomationElement.TryGetCurrentPattern Method

Retrieves an object that implements a control pattern.

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

public bool TryGetCurrentPattern(
	AutomationPattern pattern,
	out Object patternObject
)

Parameters

pattern
Type: System.Windows.Automation.AutomationPattern

The identifier of the control pattern to retrieve.

patternObject
Type: System.Object%

On return, the control pattern if it is supported; otherwise null.

Return Value

Type: System.Boolean
true if the pattern is supported; otherwise false.

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

The following example shows how to use this method to retrieve a control pattern.

// element is an AutomationElement.
object objPattern;
SelectionPattern selPattern;
if (true == element.TryGetCurrentPattern(SelectionPattern.Pattern, out objPattern))
{
    selPattern = objPattern as SelectionPattern;
}

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