ITextRangeProvider interface

Provides access to a span of continuous text in a text container that implements ITextProvider or ITextProvider2.

Methods

The ITextRangeProvider interface has these methods.

Method Description
ITextRangeProvider::AddToSelection Adds the text range to the collection of selected text ranges in a control that supports multiple, disjoint spans of selected text.
ITextRangeProvider::Clone Returns a new ITextRangeProvider identical to the original ITextRangeProvider and inheriting all properties of the original.
ITextRangeProvider::Compare Retrieves a value that specifies whether this text range has the same endpoints as another text range.
ITextRangeProvider::CompareEndpoints Returns a value that specifies whether two text ranges have identical endpoints.
ITextRangeProvider::ExpandToEnclosingUnit Normalizes the text range by the specified text unit. The range is expanded if it is smaller than the specified unit, or shortened if it is longer than the specified unit.
ITextRangeProvider::FindAttribute Returns a text range subset that has the specified text attribute value.
ITextRangeProvider::FindText Returns a text range subset that contains the specified text.
ITextRangeProvider::GetAttributeValue Retrieves the value of the specified text attribute across the text range.
ITextRangeProvider::GetBoundingRectangles Retrieves a collection of bounding rectangles for each fully or partially visible line of text in a text range.
ITextRangeProvider::GetChildren Retrieves a collection of all embedded objects that fall within the text range.
ITextRangeProvider::GetEnclosingElement Returns the innermost element that encloses the text range.
ITextRangeProvider::GetText Retrieves the plain text of the range.
ITextRangeProvider::Move Moves the text range forward or backward by the specified number of text units.
ITextRangeProvider::MoveEndpointByRange Moves one endpoint of the current text range to the specified endpoint of a second text range.
ITextRangeProvider::MoveEndpointByUnit Moves one endpoint of the text range the specified number of TextUnit units within the document range.
ITextRangeProvider::RemoveFromSelection Removes the text range from the collection of selected text ranges in a control that supports multiple, disjoint spans of selected text.
ITextRangeProvider::ScrollIntoView Causes the text control to scroll vertically until the text range is visible in the viewport.
ITextRangeProvider::Select Selects the span of text that corresponds to this text range, and removes any previous selection.

Remarks

A range can represent an insertion point, a portion of text, or all of the text in a container.

Requirements

   
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)

See Also

Conceptual

ITextProvider

Reference

UI Automation Providers Overview