Global

Members

FunctionKeys

Represents the function keys.

Properties:
NameTypeDescription
f1stringKey F1.
f2stringKey F2.
f3stringKey F3.
f4stringKey F4.
f5stringKey F5.
f6stringKey F6.
f7stringKey F7.
f8stringKey F8.
f9stringKey F9.
f10stringKey F10.
f11stringKey F11.
f12stringKey F12.

KeyModifier

Represents additional pressed keys.
Properties:
NameTypeDescription
nonenumberNo Modifier
ctrlnumberKey CTRL is pressed
leftCtrlnumberKey left CTRL is pressed
rightCtrlnumberKey right CTRL is pressed
altnumberKey ALT is pressed
leftAltnumberKey left ALT is pressed
rightAltnumberKey right ALT is pressed
shiftnumberKey SHIFT is pressed
leftShiftnumberKey left SHIFT is pressed
rightShiftnumberKey right SHIFT is pressed
windowsLogonumberKey WINDOW is pressed
leftWindowsLogonumberKey left WINDOW is pressed
rightWindowsLogonumberKey right WINDOW is pressed

Keys

Represents keyboard keys.
Properties:
NameTypeDescription
insertstringKey INSERT
deletestringKey DELETE
homestringKey HOME
endstringKey END
pageUpstringKey PAGE UP
pageDownstringKey PAGE DOWN
upstringKey UP
downstringKey DOWN
leftstringKey LEFT
rightstringKey RIGHT
escstringKey ESC
backspacestringKey BACKSPACE
returnstringKey ENTER
tabstringKey TAB
pausestringKey PAUSE/BREAK
printScrstringKey PRINT SCREEN
appKeystringKey APPLICATION
f1stringKey F1
f2stringKey F2
f3stringKey F3
f4stringKey F4
f5stringKey F5
f6stringKey F6
f7stringKey F7
f8stringKey F8
f9stringKey F9
f10stringKey F10
f11stringKey F11
f12stringKey F12
numLockOnstringKey NUMLOCK ON
capsLockOnstringKey CAPS LOCK ON
scrollLockOnstringKey SCROLL LOCK ON
numLockOffstringKey NUMLOCK OFF
capsLockOffstringKey CAPS LOCK OFF
scrollLockOffstringKey SCROLL LOCK OFF

ScrollOrientation :ScrollOrientation

Represents the orientation of the scroll bar.
Properties:
NameTypeDescription
horizontalScrollnumberHorizontal scroll bar orientation.
verticalScrollnumberVertical scroll bar orientation.

WindowExtendedStyles

Represents extended window style properties.
Properties:
NameTypeDescription
ws_EX_ACCEPTFILESnumberThe window accepts drag and drop files.
ws_EX_APPWINDOWnumberForces a top-level window onto the taskbar when the window is visible.
ws_EX_CLIENTEDGEnumberThe window has a border with a sunken edge.
ws_EX_COMPOSITEDnumberPaints all descendants of a window in bottom-to-top painting order using double-buffering.
ws_EX_CONTEXTHELPnumberThe title bar of the window includes a question mark. When the user clicks the question mark, the cursor changes to a question mark with a pointer.
ws_EX_CONTROLPARENTnumberThe window contains child windows that take part in dialog box navigation.
ws_EX_DLGMODALFRAMEnumberThe window has a double border.
ws_EX_LAYEREDnumberThe window is a layered window.
ws_EX_LAYOUTRTLnumberIf the shell language is Hebrew, Arabic, or another language that supports reading order alignment, the horizontal origin of the window is on the right edge. Increasing horizontal values advance to the left. For other languages, the style is ignored.
ws_EX_LEFTnumberThe window has generic left-aligned properties. This is the default.
ws_EX_LEFTSCROLLBARnumberIf the shell language is Hebrew, Arabic, or another language that supports reading order alignment, the vertical scroll bar (if present) is to the left of the client area. For other languages, the style is ignored.
ws_EX_LTRREADINGnumberThe window text is displayed using left-to-right reading-order properties. This is the default.
ws_EX_MDICHILDnumberThe window is an MDI child window.
ws_EX_NOACTIVATEnumberA top-level window created with this style does not become the foreground window when the user clicks it.
ws_EX_NOINHERITLAYOUTnumberThe window does not pass its window layout to its child windows.
ws_EX_NOPARENTNOTIFYnumberA child window created with this style does not send the WM_PARENTNOTIFY message to its parent window when it is created or destroyed.
ws_EX_NOREDIRECTIONBITMAPnumberThe window does not render to a redirection surface. This is for windows that do not have visible content or that use mechanisms other than surfaces to provide their visual.
ws_EX_OVERLAPPEDWINDOWnumberThe window is an overlapped window.
ws_EX_PALETTEWINDOWnumberThe window is a palette window, which is a modeless dialog box that presents an array of commands.
ws_EX_RIGHTnumberThe window has generic right-aligned properties.
ws_EX_RIGHTSCROLLBARnumberThe vertical scroll bar (if present) is to the right of the client area. This is the default.
ws_EX_RTLREADINGnumberIf the shell language is Hebrew, Arabic, or another language that supports reading-order alignment, the window text is displayed using right-to-left reading-order properties. For other languages, the style is ignored.
ws_EX_STATICEDGEnumberThe window has a three-dimensional border style intended to be used for items that do not accept user input.
ws_EX_TOOLWINDOWnumberThe window is intended to be used as a floating toolbar.
ws_EX_TOPMOSTnumberThe window is placed above all non-topmost windows and stays above them, even when the window is deactivated.
ws_EX_TRANSPARENTnumberThe window is not painted until siblings beneath the window (that were created by the same thread) have been painted.
ws_EX_WINDOWEDGEnumberThe window has a border with a raised edge.

WindowState

Represents the window's current state (maximized/minimized).
Properties:
NameTypeDescription
maximizedstringThe window is maximized.
minimizedstring

The window is minimized.

normalstringThe window is in normal-restored state.

WindowStyles

Represents window style properties.
Properties:
NameTypeDescription
ws_BORDERnumberThe window has a thin-line border.
ws_CAPTIONnumberThe window has a title bar (includes the ws_BORDER style).
ws_CHILDnumberThe window is a child window. A window with this style cannot have a menu bar. This style cannot be used with the ws_POPUP style.
ws_CHILDWINDOWnumberSame as the ws_CHILD style.
ws_CLIPCHILDRENnumberExcludes the area occupied by child windows when drawing occurs within the parent window. This style is used when creating the parent window.
ws_CLIPSIBLINGSnumberClips child windows relative to each other. That is, when a particular child window receives a WM_PAINT message, the ws_CLIPSIBLINGS style clips all other overlapping child windows out of the region of the child window to be updated. If ws_CLIPSIBLINGS is not specified and child windows overlap, it is possible, when drawing within the client area of a child window, to draw within the client area of a neighboring child window.
ws_DISABLEDnumberThe window is initially disabled. A disabled window cannot receive input from the user.
ws_DLGFRAMEnumberThe window has a border of a style typically used with dialog boxes. A window with this style cannot have a title bar.
ws_GROUPnumberThe window is the first control of a group of controls. The group consists of this first control and all controls defined after it, up to the next control with the ws_GROUP style.
ws_HSCROLLnumberThe window has a horizontal scroll bar.
ws_ICONICnumberThe window is initially minimized. Same as the ws_MINIMIZE style.
ws_MAXIMIZEnumberThe window is initially maximized.
ws_MAXIMIZEBOXnumberThe window has a maximize button.
ws_MINIMIZEnumberThe window is initially minimized. Same as the ws_ICONIC style.
ws_MINIMIZEBOXnumberThe window has a minimize button.
ws_OVERLAPPEDnumberThe window is an overlapped window. An overlapped window has a title bar and a border. Same as the ws_TILED style.
ws_OVERLAPPEDWINDOWnumberThe window is an overlapped window. Same as the ws_TILEDWINDOW style.
ws_POPUPnumberThe window is a pop-up window.
ws_POPUPWINDOWnumberThe window is a pop-up window.
ws_SIZEBOXnumberThe window has a sizing border. Same as the ws_THICKFRAME style.
ws_SYSMENUnumberThe window has a window menu on its title bar.
ws_TABSTOPnumberThe window is a control that can receive the keyboard focus when the user presses the TAB key.
ws_THICKFRAMEnumberThe window has a sizing border. Same as the ws_SIZEBOX style.
ws_TILEDnumberThe window is an overlapped window. An overlapped window has a title bar and a border. Same as the ws_OVERLAPPED style.
ws_TILEDWINDOWnumberThe window is an overlapped window. Same as the ws_OVERLAPPEDWINDOW style.
ws_VISIBLEnumberThe window is initially visible.
ws_VSCROLLnumberThe window has a vertical scroll bar.

Type Definitions

CheckedState

The state of a check box.
Type:
Properties:
NameTypeDescription
uncheckedstring
checkedstring
indeterminatestring

DateFormatType

Indicates whether a date entity refers to a single date or to one or more date ranges.
Type:
Properties:
NameTypeDescription
nonestring
singleDatestring
singleDateRangestring
multipleDateRangesstring

GridSelectionMode

The selections that are possible in a grid.
Properties:
NameTypeDescription
rowsAndColumnsstringOnly rows and columns can be selected; individual cells cannot be selected.
listboxSinglestringOnly one row can be selected.
listboxMultiplestringOne or more rows can be selected.
freestringAny selection can be made.

Horizontal

The horizontal location of the related test object relative to the object to identify. See the LeanFT Help Center for a diagram that illustrates the way LeanFT interprets visual relations and the boundaries that are used for determining in-line related objects. Possible values for the 'Horizontal' type.
Properties:
NameTypeDescription
leftstringThe related test object is located to the left of the test object to identify
rightstringThe related test object is located to the right of the test object to identify

Location

The location (relative to an object in the application) at which to perform the operations.
Properties:
NameTypeDescription
anchorPositionThe position within the object from which the offset is taken.
offsetObjectThe offset from the anchor position.
Properties
NameTypeDescription
xnumberThe x-coordinate of the offset.
ynumberThe y-coordinate of the offset.

MouseButton

The mouse button to use.
Properties:
NameTypeDescription
leftstringLeft mouse button
rightstringRight mouse button
middlestringMiddle mouse button

Point

The coordinates of a point on the screen.
Properties:
NameTypeDescription
xnumberThe x coordinate of this point.
ynumberThe y coordinate of this point.

Position

Indicates the corners or center of an object.
Properties:
NameTypeDescription
topLeftstringThe top-left corner of this object.
topRightstringThe top-right corner of this object.
centerstringThe center of this object.
bottomLeftstringThe bottom-left corner of this object.
bottomRightstringThe bottom-right corner of this object.

Proximity

The distance or hierarchical location of the related test object relative to the object to identify. See the LeanFT Help Center for more details on VRI. Possible values for the 'Proximity' type.
Properties:
NameTypeDescription
closestOnXAxisstringThe related test object is the closest object on the x-axis to the test object to identify.
closestOnYAxisstringThe related test object is the closest object on the y-axis to the test object to identify.
closestOnBothAxesstringThe related test object is the closest object on both the x- and y- axes to the test object to identify.
containsstringThe related test object contains the test object to identify.

ScrollType

The type of scrolling operation.
Properties:
NameTypeDescription
lineDecrementstring Decrement the scroll by lines.
lineIncrementstring Increment the scroll by lines.
pageDecrementstring Decrement the scroll by pages.
pageIncrementstring Increment the scroll by pages.
setSpecificLinestring Move the scroll bar to a specific position.
firststring Move the scroll bar to its beginning position.
laststring Move the scroll bar to its end position.

SwipeDirection

The direction of the swipe.
Properties:
NameTypeDescription
leftstringSwipes left.
rightstringSwipes right.
upstringSwipes up.
downstringSwipes down.

Vertical

The vertical location of the related test object relative to the object to identify. See the LeanFT Help Center for a diagram that illustrates the way LeanFT interprets visual relations and the boundaries that are used for determining in-line related objects. Possible values for the 'Vertical' type.
Properties:
NameTypeDescription
abovestringThe related test object is located above the test object to identify.
belowstringThe related test object is located below the test object to identify.

VerticalScrollPosition

The position of the Vertical scrollbar.
Properties:
NameTypeDescription
leftstringThe vertical scrollbar is on the left.
rightstringThe vertical scrollbar is on the right.
nonestringThere is no vertical scrollbar.