AutomationPattern Class

Reference

Definition

Namespace:: System.Windows.Automation

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.

Identifies a control pattern.

public ref class AutomationPattern : System::Windows::Automation::AutomationIdentifier

public class AutomationPattern : System.Windows.Automation.AutomationIdentifier

type AutomationPattern = class
    inherit AutomationIdentifier

Public Class AutomationPattern
Inherits AutomationIdentifier

Inheritance: Object

AutomationIdentifier
AutomationPattern

Examples

The following example displays the ProgrammaticName of patterns supported by an AutomationElement.

The following example shows how to request a specific pattern.

/// <summary>
/// Retrieves the selection container for a selection item.
/// </summary>
/// <param name="listItem">
/// An element that supports SelectionItemPattern.
/// </param>
AutomationElement GetListItemParent(AutomationElement listItem)
{
    if (listItem == null) throw new ArgumentException();
    SelectionItemPattern pattern = listItem.GetCurrentPattern(SelectionItemPattern.Pattern) as SelectionItemPattern;
    if (pattern == null)
    {
        return null;
    }
    else
    {
        SelectionItemPattern.SelectionItemPatternInformation properties = pattern.Current;
        return properties.SelectionContainer;
    }
}

''' <summary>
''' Retrieves the selection container for a selection item.
''' </summary>
''' <param name="listItem">
''' An element that supports SelectionItemPattern.
''' </param>
Function GetListItemParent(ByVal listItem As AutomationElement) As AutomationElement
    If listItem Is Nothing Then
        Throw New ArgumentException()
    End If
    Dim pattern As SelectionItemPattern = _
        DirectCast(listItem.GetCurrentPattern(SelectionItemPattern.Pattern), SelectionItemPattern)
    If pattern Is Nothing Then
        Return Nothing
    Else
        Dim properties As SelectionItemPattern.SelectionItemPatternInformation = pattern.Current
        Return properties.SelectionContainer
    End If

End Function 'GetListItemParent

Remarks

Instances of this type identify specific control patterns. For example, the DockPattern.Pattern field identifies the DockPattern control pattern.

Properties

Id	Gets the underlying numerical identifier. (Inherited from AutomationIdentifier)
ProgrammaticName	Gets the registered programmatic name. (Inherited from AutomationIdentifier)

Methods

CompareTo(Object)	Compares this AutomationIdentifier with another AutomationIdentifier. (Inherited from AutomationIdentifier)
Equals(Object)	Returns a value indicating whether the supplied AutomationIdentifier is equivalent to this AutomationIdentifier. (Inherited from AutomationIdentifier)
GetHashCode()	Returns the hash code for this UI Automation identifier. (Inherited from AutomationIdentifier)
GetType()	Gets the Type of the current instance. (Inherited from Object)
LookupById(Int32)	Retrieves an AutomationPattern that encapsulates a specified numerical identifier.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Deila með