AutomationElement.TryGetCurrentPattern Method (AutomationPattern, Object)

 

Retrieves an object that implements a control pattern.

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

Public Function TryGetCurrentPattern (
	pattern As AutomationPattern,
	<OutAttribute> ByRef patternObject As Object
) As Boolean

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.
Dim objPattern As Object = Nothing
Dim selPattern As SelectionPattern
If True = element.TryGetCurrentPattern(SelectionPattern.Pattern, objPattern) Then
    selPattern = DirectCast(objPattern, SelectionPattern)
End If

.NET Framework
Available since 3.0
Return to top
Show: