The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITextProvider::RangeFromPoint method

Returns the degenerate (empty) text range nearest to the specified screen coordinates.

Syntax

C++


HRESULT RangeFromPoint(
  [in]          UiaPoint           point,
  [out, retval] ITextRangeProvider **pRetVal
);

Parameters

point [in]

Type: UiaPoint

The location in screen coordinates.

pRetVal [out, retval]

Type: ITextRangeProvider**

Receives a pointer to the degenerate (empty) text range nearest the specified location. This parameter is passed uninitialized.

Return value

Type: HRESULT

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

Remarks

A text range that encloses a child object is returned if the screen coordinates are within the coordinates of an image, hyperlink, or other embedded object.

Because hidden text is not ignored by ITextProvider::RangeFromPoint, a degenerate range from the visible text closest to the given point is returned.

The property never returns NULL.

Requirements

Minimum supported client	Windows XP [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2003 [desktop apps \| Windows Store apps]
Header	UIAutomationCore.h (include UIAutomation.h)
IDL	UIAutomationCore.idl