TextPatternRange.GetEnclosingElement Method

Definition

Namespace:

System.Windows.Automation.Text

Assembly:

UIAutomationClient.dll

Returns the innermost AutomationElement that encloses the text range.

public:
 System::Windows::Automation::AutomationElement ^ GetEnclosingElement();

public System.Windows.Automation.AutomationElement GetEnclosingElement ();

member this.GetEnclosingElement : unit -> System.Windows.Automation.AutomationElement

Public Function GetEnclosingElement () As AutomationElement

Returns

AutomationElement

The innermost element enclosing the caller.

Examples

 private AutomationElement EnclosingElementFromSelection(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[] currentSelection = textpatternPattern.GetSelection();

    return currentSelection[0].GetEnclosingElement();
}

Private Function EnclosingElementFromSelection(ByVal target As AutomationElement) As AutomationElement
    ' 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()
    Return currentSelection(0).GetEnclosingElement()
End Function

Remarks

The enclosing AutomationElement, typically the text provider that supplies the text range. However, if the text provider supports child elements such as tables or hyperlinks, then the enclosing element could be a descendant of the text provider.