This documentation is archived and is not being maintained.

TextPattern.Pattern Field

Identifies the TextPattern pattern.

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

public static readonly AutomationPattern Pattern
public static final AutomationPattern Pattern
public static final var Pattern : AutomationPattern
Not applicable.

This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in TextPatternIdentifiers.

The pattern identifier is passed to methods such as GetCurrentPattern to retrieve the control pattern of interest from the specified AutomationElement.

// Set up the conditions for finding the text control.
PropertyCondition documentControl = new PropertyCondition(
    AutomationElement.ControlTypeProperty,
    ControlType.Document);
PropertyCondition textPatternAvailable = new PropertyCondition(
    AutomationElement.IsTextPatternAvailableProperty, true);
AndCondition findControl =
    new AndCondition(documentControl, textPatternAvailable);

// Get the Automation Element for the first text control found.
// For the purposes of this sample it is sufficient to find the 
// first text control. In other cases there may be multiple text
// controls to sort through.
targetDocument =
    targetWindow.FindFirst(TreeScope.Descendants, findControl);

// Didn't find a text control.
if (targetDocument == null)
{
    targetResult.Content =
        WPFTarget +
        " does not contain a Document control type.";
    targetResult.Background = Brushes.Salmon;
    startWPFTargetButton.IsEnabled = false;
    return;
}

// Get required control patterns 
targetTextPattern =
    targetDocument.GetCurrentPattern(
    TextPattern.Pattern) as TextPattern;

// Didn't find a text control that supports TextPattern.
if (targetTextPattern == null)
{
    targetResult.Content =
        WPFTarget +
        " does not contain an element that supports TextPattern.";
    targetResult.Background = Brushes.Salmon;
    startWPFTargetButton.IsEnabled = false;
    return;
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0
Show: