Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Retrieves an array of disjoint text ranges from a text container where each text range begins with the first partially visible line through to the end of the last partially visible line.
Syntax
HRESULT GetVisibleRanges( SAFEARRAY **pRetVal );
Parameters
- pRetVal
[out, retval] The address of a variable that receives an array of pointers to the ITextRangeProvider interfaces of the visible text ranges or an empty array. A NULL reference is never returned. This parameter is passed uninitialized.
Return Value
Returns S_OK if successful, or an error value otherwise.
Remarks
UI Automation providers should ensure that they return, at most, the text ranges that are visible within the container.
Disjoint text ranges may occur when any content of a text container is obscured by an overlapping window or other object, or when a text container with a multi-column layout has one or more columns partially scrolled out of view.
If no text is visible, a degenerate (empty) text range is returned. This empty range can be returned if the text container is empty or when all text is scrolled out of view.
See Also
UI Automation Providers Overview, ITextRangeProvider, Working with Safe Arrays