This topic has not yet been rated - Rate this topic

AutomationElement.TryGetCurrentPattern Method

.NET Framework 4.5

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.

Remarks

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.

Examples

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;
}

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

AutomationElement Class

System.Windows.Automation Namespace

GetCurrentPattern

TryGetCachedPattern

Other Resources

UI Automation Control Patterns for Clients

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)