IRawElementProviderSimple.GetPatternProvider(Int32) Method

Reference

Definition

Namespace:: System.Windows.Automation.Provider

Assembly:: UIAutomationProvider.dll

Assemblies:: UIAutomationProvider.dll, UIAutomationTypes.dll

Assembly:: UIAutomationTypes.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 provides support for a control pattern on a UI Automation element.

public:
 System::Object ^ GetPatternProvider(int patternId);

public object GetPatternProvider(int patternId);

abstract member GetPatternProvider : int -> obj

Public Function GetPatternProvider (patternId As Integer) As Object

Parameters

patternId: Int32

Identifier of the pattern.

Returns

Object

Object that implements the pattern interface, or null if the pattern is not supported.

Examples

The following example shows an implementation of GetPatternProvider for a provider that supports only InvokePattern.

/// <summary>
/// Returns the object that supports the specified pattern.
/// </summary>
/// <param name="patternId">ID of the pattern.</param>
/// <returns>Object that implements IInvokeProvider.</returns>
object IRawElementProviderSimple.GetPatternProvider(int patternId)
{
    if (patternId == InvokePatternIdentifiers.Pattern.Id)
    {
        // Return an object that implements IInvokeProvider.
        return myInvokePatternProvider;
    }
    else
    {
        return null;
    }
}

''' <summary>
''' Returns the object that supports the specified pattern.
''' </summary>
''' <param name="patternId">ID of the pattern.</param>
''' <returns>Object that implements IInvokeProvider.</returns>
Function GetPatternProvider(ByVal patternId As Integer) As Object _
    Implements IRawElementProviderSimple.GetPatternProvider
    If patternId = InvokePatternIdentifiers.Pattern.Id Then
        ' Return an object that implements IInvokeProvider.
        Return myInvokePatternProvider
    Else
        Return Nothing
    End If

End Function 'IRawElementProviderSimple.GetPatternProvider

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via