This documentation is archived and is not being maintained.

TextPatternRange.FindAttribute Method

Returns a text range subset that has the specified attribute value.

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

public TextPatternRange FindAttribute (
	AutomationTextAttribute attribute,
	Object value,
	bool backward
)
public TextPatternRange FindAttribute (
	AutomationTextAttribute attribute, 
	Object value, 
	boolean backward
)
public function FindAttribute (
	attribute : AutomationTextAttribute, 
	value : Object, 
	backward : boolean
) : TextPatternRange
Not applicable.

Parameters

attribute

The attribute to search for.

value

The attribute value to search for. This value must match the type specified for the attribute.

backward

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

Return Value

A text range having a matching attribute and attribute value; otherwise null (Nothing in Microsoft Visual Basic .NET).

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

NoteNote:

Use DocumentRange to search the entire document.

 private TextPatternRange RangeFromAttribute(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[] currentSelelction = textpatternPattern.GetSelection();
    // Find 'italic' range
    return currentSelelction[0].FindAttribute(TextPattern.IsItalicAttribute, true, false);
}

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: