TextPatternRange Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents a span of continuous text in a TextPattern container.

Namespace:   System.Windows.Automation.Text
Assembly:  UIAutomationClient (in UIAutomationClient.dll)


public class TextPatternRange


Gets the TextPattern associated with the text range.


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


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


Returns a Boolean value indicating whether the span (the Start endpoint to the End endpoint) of a text range is the same as another text range.

System_CAPS_pubmethodCompareEndpoints(TextPatternRangeEndpoint, TextPatternRange, TextPatternRangeEndpoint)

Returns an Int32 indicating whether two text ranges have identical endpoints.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Expands the text range to the specified TextUnit.


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindAttribute(AutomationTextAttribute, Object, Boolean)

Returns a text range subset that has the specified attribute value.

System_CAPS_pubmethodFindText(String, Boolean, Boolean)

Returns a text range subset that contains the specified text.


Returns the value of the specified attribute across the entire text range.


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


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


Returns the innermost AutomationElement that encloses the text range.


Serves as the default hash function. (Inherited from Object.)


Returns the plain text of the text range.


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodMove(TextUnit, Int32)

Moves the text range the specified number of text units.

System_CAPS_pubmethodMoveEndpointByRange(TextPatternRangeEndpoint, TextPatternRange, TextPatternRangeEndpoint)

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

System_CAPS_pubmethodMoveEndpointByUnit(TextPatternRangeEndpoint, TextUnit, Int32)

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


Removes a highlighted section of text, corresponding to the calling text range Start and End endpoints, from an existing collection of highlighted text in a text container that supports multiple, disjoint selections.


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


Highlights text in the text control corresponding to the text range Start and End endpoints.


Returns a string that represents the current object.(Inherited from Object.)

A TextPatternRange can represent an insertion point, a subset, or all of the text in a TextPattern container.

A TextPatternRange will become invalid if one of the following occurs: the text in the TextPattern container changes because of some user activity, or the SetValue method of ValuePattern is used to programmatically change the value of the text in the TextPattern container.

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top