IUIAutomationTextRange::GetBoundingRectangles method

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

Syntax


HRESULT GetBoundingRectangles(
  [out, retval]  SAFEARRAY **boundingRects[double]
);

Parameters

boundingRects [out, retval]

Type: SAFEARRAY**

Receives a pointer to an array of bounding rectangles for each fully or partially visible line of text in a text range. An empty array is returned for a degenerate (empty) text range or for a text range that is completely off-screen, scrolled out of view, or obscured by an overlapping window.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

For information about how the bounding rectangles are stored in the SAFEARRAY, see Best Practices for Using Safe Arrays.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista, Windows XP with SP3 and Platform Update for Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008, Windows Server 2003 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]

Header

UIAutomationClient.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

See also

Reference
IUIAutomationTextRange
SafeArrayToRectNativeArray
Conceptual
UI Automation Support for Textual Content

 

 

Community Additions

ADD
Show:
© 2014 Microsoft