Jaa

ITextProvider Interface

  • Reference

Definition

Namespace:
Windows.UI.Xaml.Automation.Provider
Edit

Exposes methods and properties to support Microsoft UI Automation client access to controls that contain text. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Text.

public interface class ITextProvider
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(3680222367, 18439, 20266, 134, 120, 27, 19, 243, 198, 14, 34)]
struct ITextProvider
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(3680222367, 18439, 20266, 134, 120, 27, 19, 243, 198, 14, 34)]
public interface ITextProvider
Public Interface ITextProvider
Derived
Attributes
ContractVersionAttribute GuidAttribute

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 Microsoft UI Automation interfaces within the Windows Runtime API exist so that custom control authors can support the automation pattern in a custom control, and implement their automation support using the same Windows Runtime managed or C++ API as they use to define control logic or other automation support.

The ITextProvider pattern doesn't have a Windows Runtime property identifier class.

Properties

DocumentRange

Gets a text range that encloses the main text of a document.
SupportedTextSelection

Gets a value that specifies whether a text provider supports selection, and if it does, the type of selection that is supported.

Methods

GetSelection()

Retrieves a collection of disjoint text ranges that are associated with the current text selection or selections.
GetVisibleRanges()

Retrieves an array of disjoint text ranges from a text container. Each text range begins with the first partially visible line and ends with the last partially visible line.
RangeFromChild(IRawElementProviderSimple)

Retrieves a text range that encloses a child element, such as an image, hyperlink, or other embedded object.
RangeFromPoint(Point)

Retrieves a text range from the vicinity of a screen coordinate.

Applies to

See also