ITextRangeProvider Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Exposes methods and properties to support Microsoft UI Automation client access to a span of continuous text in a text container that implements ITextProvider.
public interface class ITextRangeProvider/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(41183373, 1769, 20326, 148, 70, 40, 165, 190, 152, 251, 208)]
struct ITextRangeProvider[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(41183373, 1769, 20326, 148, 70, 40, 165, 190, 152, 251, 208)]
public interface ITextRangeProviderPublic Interface ITextRangeProvider- Derived
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Remarks
For more info on this pattern, see Text and TextRange Control Patterns.
ITextProvider, ITextProvider2 and ITextRangeProvider aren't implemented by any existing Windows Runtime automation peers using this definition of the interface. The text models supported by Windows Runtime text controls such as TextBox and RichTextBlock do implement some of these patterns, but do so at a native level that doesn't appear in the Windows Runtime definitions of the API surface. For more info, see the peer classes for the various Windows Runtime text controls.
The ITextRangeProvider pattern doesn't have a Windows Runtime property identifier class.
Methods
| AddToSelection() |
Adds to the collection of highlighted text in a text container that supports multiple disjoint selections. |
| Clone() |
Returns a new ITextRangeProvider that is identical to the original ITextRangeProvider and that inherits all the properties of the original. |
| Compare(ITextRangeProvider) |
Returns a value that indicates whether the start and end points of a text range are the same as another text range. |
| CompareEndpoints(TextPatternRangeEndpoint, ITextRangeProvider, TextPatternRangeEndpoint) |
Returns a value that indicates whether two text ranges have identical endpoints. |
| ExpandToEnclosingUnit(TextUnit) |
Expands the text range to the specified text unit. |
| FindAttribute(Int32, Object, Boolean) |
Returns a text range subset that has the specified attribute ID and attribute value. |
| FindText(String, Boolean, Boolean) |
Returns a text range subset that contains the specified text. |
| GetAttributeValue(Int32) |
Retrieves the value of the specified attribute ID across the text range. |
| GetBoundingRectangles(Double[]) |
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 the embedded objects that exist within the text range. |
| GetEnclosingElement() |
Returns the innermost element that encloses the text range. |
| GetText(Int32) |
Retrieves the plain text of the range. |
| Move(TextUnit, Int32) |
Moves the text range the specified number of text units. |
| MoveEndpointByRange(TextPatternRangeEndpoint, ITextRangeProvider, TextPatternRangeEndpoint) |
Moves one endpoint of a text range to the specified endpoint of a second text range. |
| MoveEndpointByUnit(TextPatternRangeEndpoint, TextUnit, Int32) |
Moves one endpoint of the text range the specified number of text units within the document range. |
| RemoveFromSelection() |
From the collection of highlighted text in a text container that supports multiple disjoint selections, removes a highlighted section of text that corresponds to the caller's text range endpoints. |
| ScrollIntoView(Boolean) |
Causes the text control to scroll vertically until the text range is visible in the viewport. |
| Select() |
Highlights text in the text control that corresponds to the start and end endpoints of the text range. |