Share this page
com.hp.lft.sdk.uiapro
Interface TextPattern
Supported in UFT Developer version 24.2 and later
UIA Pro is supported as a technical preview.
public interface TextPatternThe methods and properties used to interact with text.
Method Summary
Modifier and Type Method and Description voidclearSelection()Deselect all / any selected text from the objectStringgetSelection()SupportedTextSelectiongetSupportedTextSelection()StringgetText()StringgetVisibleText()voidscrollIntoView(int numberOfUnits)Scrolls into view.voidscrollIntoView(int numberOfUnits, TextUnit unitType)Scrolls into view.voidscrollIntoView(int numberOfUnits, TextUnit unitType, Direction direction)Scrolls into view.voidscrollIntoView(int numberOfUnits, TextUnit unitType, Direction direction, Alignment alignment)Scrolls into view.voidselect(int start)Selects the specified text in the object.voidselect(int start, int length)Selects the specified text in the object.voidselectAll()Selects all the object’s text.
Method Detail
getText
String getText() throws GeneralLeanFtException
- Returns:
- The object's text.
- Throws:
GeneralLeanFtException- if error occurs during execution.
getVisibleText
String getVisibleText() throws GeneralLeanFtException
- Returns:
- The object's visible text.
- Throws:
GeneralLeanFtException- if error occurs during execution.
getSelection
String getSelection() throws GeneralLeanFtException
- Returns:
- The object’s selected text, or an empty string if no text is selected.
- Throws:
GeneralLeanFtException- if error occurs during execution.
getSupportedTextSelection
SupportedTextSelection getSupportedTextSelection() throws GeneralLeanFtException
- Returns:
- The type of text selection that is supported by the control.
- Throws:
GeneralLeanFtException- if error occurs during execution.
clearSelection
void clearSelection() throws GeneralLeanFtExceptionDeselect all / any selected text from the object- Throws:
GeneralLeanFtException- if error occurs during execution.
scrollIntoView
void scrollIntoView(int numberOfUnits) throws GeneralLeanFtExceptionScrolls into view.- Parameters:
numberOfUnits- 0-based index- Throws:
GeneralLeanFtException- if error occurs during execution.
scrollIntoView
void scrollIntoView(int numberOfUnits, TextUnit unitType) throws GeneralLeanFtExceptionScrolls into view.- Parameters:
numberOfUnits- 0-based indexunitType- The unit type- Throws:
GeneralLeanFtException- if error occurs during execution.
scrollIntoView
void scrollIntoView(int numberOfUnits, TextUnit unitType, Direction direction) throws GeneralLeanFtExceptionScrolls into view.- Parameters:
numberOfUnits- 0-based indexunitType- The unit typedirection- The direction of scrolling- Throws:
GeneralLeanFtException- if error occurs during execution.
scrollIntoView
void scrollIntoView(int numberOfUnits, TextUnit unitType, Direction direction, Alignment alignment) throws GeneralLeanFtExceptionScrolls into view.- Parameters:
numberOfUnits- 0-based indexunitType- The unit typedirection- The direction of scrollingalignment- The alignment- Throws:
GeneralLeanFtException- if error occurs during execution.
select
void select(int start) throws GeneralLeanFtExceptionSelects the specified text in the object.- Parameters:
start- The 0 based index position of the selection begin- Throws:
GeneralLeanFtException- if error occurs during execution.
select
void select(int start, int length) throws GeneralLeanFtExceptionSelects the specified text in the object.- Parameters:
start- The 0 based index position of the selection beginlength- The number of characters to be selected. If not specified all remaining text will be selected- Throws:
GeneralLeanFtException- if error occurs during execution.
selectAll
void selectAll() throws GeneralLeanFtExceptionSelects all the object’s text.- Throws:
GeneralLeanFtException- if error occurs during execution.
