IUIAutomationTextPattern::RangeFromChild method

Retrieves a text range enclosing a child element such as an image, hyperlink, Microsoft Excel spreadsheet, or other embedded object.

Syntax


HRESULT RangeFromChild(
  [in]          IUIAutomationElement   *child,
  [out, retval] IUIAutomationTextRange **range
);

Parameters

child [in]

Type: IUIAutomationElement*

A pointer to the child element to be enclosed in the text range.

range [out, retval]

Type: IUIAutomationTextRange**

Receives a pointer to a text range that encloses the child element.

Return value

Type: HRESULT

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

Remarks

If there is no text in the range that encloses the child element, a degenerate (empty) range is returned.

The child parameter is either a child of the element associated with a IUIAutomationTextPattern or from the array of children of a IUIAutomationTextRange.

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

IUIAutomationTextPattern
UI Automation Support for Textual Content

 

 

Show: