IUIAutomationTextRange Interface

Article
06/12/2009

Exposes properties and methods for a span of continuous text in a container that supports the IUIAutomationTextPattern interface. Client applications can use the IUIAutomationTextRange interface to select, compare, and retreive embedded objects from the text span. The interface uses two endpoints to delimit where the text span starts and ends. Disjoint spans of text are represented by an IUIAutomationTextRangeArray interface.

IUIAutomationTextRange Members

AddToSelection Adds the text range to the collection of highlighted text in a text container that supports multiple, disjoint selections.

Clone Retrieves a new IUIAutomationTextRange identical to the original and inheriting all properties of the original.

Compare Retrieves a value that specifies whether the span of this text range is the same as that of another text range.

CompareEndpoints Retrieves a value that specifies whether the start or end point of this text range is the same as the start or end point of another one.

ExpandToEnclosingUnit Expands the text range to the specified text unit.

FindAttribute Retrieves a text range subset that has the specified text attribute value.

FindText Retrieves a text range subset that contains the specified text.

GetAttributeValue Retrieves the value of the specified text attribute across the entire text range.

GetBoundingRectangles Retrieves a collection of bounding rectangles for each fully or partially visible line of text in a text range.

GetChildren Retrieves a collection of all embedded objects that fall within the text range.

GetEnclosingElement Returns the innermost UI Automation element that encloses the text range.

GetText Returns the plain text of the text range.

Move Moves the text range the specified number of text units.

MoveEndpointByRange Moves one endpoint of a text range to the specified endpoint of a second text range.

MoveEndpointByUnit Moves one endpoint of the text range the specified number of text units within the document range.

RemoveFromSelection Removes the text range from an existing collection of selected text in a text container that supports multiple, disjoint selections.

ScrollIntoView Causes the text control to scroll vertically until the text range is visible in the viewport.

Select Creates a selection in the control that corresponds to this range.

Interface Information

Inherits from IUnknown

Header and IDL files uiautomation.h, uiautomationclient.idl

Minimum operating systems Windows 7

Share via

IUIAutomationTextRange Interface

Additional resources

AddToSelection	Adds the text range to the collection of highlighted text in a text container that supports multiple, disjoint selections.
Clone	Retrieves a new IUIAutomationTextRange identical to the original and inheriting all properties of the original.
Compare	Retrieves a value that specifies whether the span of this text range is the same as that of another text range.
CompareEndpoints	Retrieves a value that specifies whether the start or end point of this text range is the same as the start or end point of another one.
ExpandToEnclosingUnit	Expands the text range to the specified text unit.
FindAttribute	Retrieves a text range subset that has the specified text attribute value.
FindText	Retrieves a text range subset that contains the specified text.
GetAttributeValue	Retrieves the value of the specified text attribute across the entire text range.
GetBoundingRectangles	Retrieves a collection of bounding rectangles for each fully or partially visible line of text in a text range.
GetChildren	Retrieves a collection of all embedded objects that fall within the text range.
GetEnclosingElement	Returns the innermost UI Automation element that encloses the text range.
GetText	Returns the plain text of the text range.
Move	Moves the text range the specified number of text units.
MoveEndpointByRange	Moves one endpoint of a text range to the specified endpoint of a second text range.
MoveEndpointByUnit	Moves one endpoint of the text range the specified number of text units within the document range.
RemoveFromSelection	Removes the text range from an existing collection of selected text in a text container that supports multiple, disjoint selections.
ScrollIntoView	Causes the text control to scroll vertically until the text range is visible in the viewport.
Select	Creates a selection in the control that corresponds to this range.

Inherits from	IUnknown
Header and IDL files	uiautomation.h, uiautomationclient.idl
Minimum operating systems	Windows 7