TextPatternRange.FindText(String, Boolean, Boolean) Method

Reference

Definition

Namespace:: System.Windows.Automation.Text

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.

Returns a text range subset that contains the specified text.

public:
 System::Windows::Automation::Text::TextPatternRange ^ FindText(System::String ^ text, bool backward, bool ignoreCase);

public System.Windows.Automation.Text.TextPatternRange FindText (string text, bool backward, bool ignoreCase);

member this.FindText : string * bool * bool -> System.Windows.Automation.Text.TextPatternRange

Public Function FindText (text As String, backward As Boolean, ignoreCase As Boolean) As TextPatternRange

Parameters

text: String

The text string to search for.

backward: Boolean

true if the last occurring text range should be returned instead of the first; otherwise false.

ignoreCase: Boolean

true if case should be ignored; otherwise false.

Returns

TextPatternRange

A text range matching the specified text; otherwise null (Nothing in Visual Basic).

Examples

 private TextPatternRange TextFromSelection(AutomationElement target)
{
    // Specify the control type we're looking for, in this case 'Document'
    PropertyCondition cond = new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Document);

    // target --> The root AutomationElement.
    AutomationElement textProvider = target.FindFirst(TreeScope.Descendants, cond);

    TextPattern textpatternPattern = textProvider.GetCurrentPattern(TextPattern.Pattern) as TextPattern;

    if (textpatternPattern == null)
    {
        Console.WriteLine("Root element does not contain a descendant that supports TextPattern.");
        return null;
    }
    TextPatternRange[] tprSelection = textpatternPattern.GetSelection();
    // Find 'text' in selection range
    return tprSelection[0].FindText("text", false, true);
}

Private Function TextFromSelection(ByVal target As AutomationElement) As TextPatternRange
    ' Specify the control type we're looking for, in this case 'Document'
    Dim cond As PropertyCondition = New PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Document)

    ' target --> The root AutomationElement.
    Dim textProvider As AutomationElement = target.FindFirst(TreeScope.Descendants, cond)

    Dim textpatternPattern As TextPattern = CType(textProvider.GetCurrentPattern(TextPattern.Pattern), TextPattern)

    If (textpatternPattern Is Nothing) Then
        Console.WriteLine("Root element does not contain a descendant that supports TextPattern.")
        Return Nothing
    End If
    Dim currentSelection As TextPatternRange() = textpatternPattern.GetSelection()
    ' Find 'text' in selection range
    Return currentSelection(0).FindText("text", False, True)
End Function

Remarks

There is no differentiation between hidden and visible text. UI Automation clients can use IsHiddenAttribute to check text visibility.

Note

Use DocumentRange to search the entire document.

Applies to

Deila með