ITextRangeProvider interface

Applies to Windows and Windows Phone

Exposes methods and properties to support Microsoft UI Automation client access to a span of continuous text in a text container that implements ITextProvider.

Syntax


public interface ITextRangeProvider

Attributes

[Version(0x06020000)]
[WebHostHidden()]

Members

The ITextRangeProvider interface has these types of members:

Methods

The ITextRangeProvider interface has these methods. It also inherits methods from the Object class.

MethodDescription
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 Returns a value that indicates whether the start and end points of a text range are the same as another text range.
CompareEndpoints Returns a value that indicates whether two text ranges have identical endpoints.
ExpandToEnclosingUnit Expands the text range to the specified text unit.
FindAttribute Returns a text range subset that has the specified attribute ID and attribute value.
FindText Returns a text range subset that contains the specified text.
GetAttributeValue Retrieves the value of the specified attribute ID across the 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 the embedded objects that exist within the text range.
GetEnclosingElement Returns the innermost element that encloses the text range.
GetText Retrieves the plain text of the 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 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 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.

 

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.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Provider
Windows::UI::Xaml::Automation::Provider [C++]

Metadata

Windows.winmd

See also

Text and TextRange Control Patterns
Custom automation peers
ITextRangeProvider (COM interface)
ITextProvider

 

 

Show:
© 2014 Microsoft