Package at.bestsolution.uia
Interface ITextProvider
- All Known Subinterfaces:
ITextEditProvider,ITextProvider2
public interface ITextProvider
Provides access to controls that contain text.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionRetrieves a text range that encloses the main text of a document.Retrieves a value that specifies the type of text selection that is supported by the control.Retrieves a collection of text ranges that represents the currently selected text in a text-based control.Retrieves an array of disjoint text ranges from a text-based control where each text range represents a contiguous span of visible text.RangeFromChild(IUIAElement childElement) Retrieves a text range enclosing a child element such as an image, hyperlink, or other embedded object.RangeFromPoint(Point2D point) Returns the degenerate (empty) text range nearest to the specified screen coordinates.
-
Method Details
-
get_DocumentRange
ITextRangeProvider get_DocumentRange()Retrieves a text range that encloses the main text of a document.- Returns:
- the document range
-
get_SupportedTextSelection
SupportedTextSelection get_SupportedTextSelection()Retrieves a value that specifies the type of text selection that is supported by the control.- Returns:
- the supported text selection
-
GetSelection
ITextRangeProvider[] GetSelection()Retrieves a collection of text ranges that represents the currently selected text in a text-based control.- Returns:
- the currently selected ranges
-
GetVisibleRanges
ITextRangeProvider[] GetVisibleRanges()Retrieves an array of disjoint text ranges from a text-based control where each text range represents a contiguous span of visible text.- Returns:
- the visible text ranges
-
RangeFromChild
Retrieves a text range enclosing a child element such as an image, hyperlink, or other embedded object.- Parameters:
childElement- the child- Returns:
- the range
-
RangeFromPoint
Returns the degenerate (empty) text range nearest to the specified screen coordinates.- Parameters:
point- the coordinates in screen space- Returns:
- the range
-