AutomationElement.TryGetCurrentPattern(AutomationPattern, Object) Method

Reference

Definition

Namespace:: System.Windows.Automation

Assembly:: UIAutomationClient.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves an object that implements a control pattern.

public:
 bool TryGetCurrentPattern(System::Windows::Automation::AutomationPattern ^ pattern, [Runtime::InteropServices::Out] System::Object ^ % patternObject);

public bool TryGetCurrentPattern (System.Windows.Automation.AutomationPattern pattern, out object patternObject);

member this.TryGetCurrentPattern : System.Windows.Automation.AutomationPattern * obj -> bool

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

Parameters

pattern: AutomationPattern

The identifier of the control pattern to retrieve.

patternObject: Object

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

Returns

Boolean

true if the pattern is supported; otherwise false.

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

' 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

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.

Applies to