ITextProvider::RangeFromPoint method (uiautomationcore.h)

Article
02/22/2024

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

Syntax

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

Parameters

[in] point

Type: UiaPoint

The location in screen coordinates.

[out, retval] pRetVal

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

Requirement	Value
Minimum supported client	Windows XP [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2003 [desktop apps \| UWP apps]
Target Platform	Windows
Header	uiautomationcore.h (include UIAutomation.h)