TextPatternRange.GetBoundingRectangles Method

Definition

Namespace:

System.Windows.Automation.Text

Assembly:

UIAutomationClient.dll

Retrieves a collection of bounding rectangles for each fully or partially visible line of text in a text range.

public:
 cli::array <System::Windows::Rect> ^ GetBoundingRectangles();

public System.Windows.Rect[] GetBoundingRectangles ();

member this.GetBoundingRectangles : unit -> System.Windows.Rect[]

Public Function GetBoundingRectangles () As Rect()

Returns

Rect[]

An array of bounding rectangles for each full or partial line of text in a text range.

An empty array for a degenerate text range.

An empty array for a text range that has screen coordinates placing it completely off-screen, scrolled out of view, or obscured by an overlapping window.

Examples

 private Rect[] BoundingRectanglesFromSelection(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].GetBoundingRectangles();
}

Private Function BoundingRectanglesFromSelection(ByVal target As AutomationElement) As Rect()
    ' 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).GetBoundingRectangles()
End Function