AutomationElement.TryGetCurrentPattern Method (AutomationPattern, Object)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Retrieves an object that implements a control pattern.

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

member TryGetCurrentPattern : 
        pattern:AutomationPattern *
        patternObject:Object byref -> bool

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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top
Show: