|
This is a rule for simulated objects.
Behavior Pattern: Win32Generic
Property Summary
Property
|
Description
|
Getter
|
Setter
|
Bitmap
|
UI Image of the object.
|
GetBitmap
|
|
BWBitmap
|
UI Image of the object in 1-bit format (black&white).
|
GetBWBitmap
|
|
Class
|
Class of the object.
|
GetClass
|
|
Height
|
Height of the object.
|
GetHeight
|
|
Name
|
Name of the object.
|
GetName
|
|
ObjectType
|
SeSMatcherRule type for this object.
|
GetObjectType
|
|
State
|
State of the object.
|
GetState
|
|
Value
|
Value of the object.
|
GetValue
|
SetValue
|
Width
|
Width of the object.
|
GetWidth
|
|
WindowText
|
Window text of the object.
|
GetWindowText
|
SetWindowText
|
X
|
X-coordinate of the top left corner of the object.
|
GetX
|
|
Y
|
Y-coordinate of the top left corner of the object.
|
GetY
|
|
Action Summary
Action
|
Description
|
DoAction
|
Performs default action for an object.
|
DoAnalogPlay
|
Plays analog recording using coordinates relative to this object.
|
DoClick
|
Performs left click at the center of an object.
|
DoEnsureVisible
|
Makes sure specified element is visible on the screen.
|
DoLButtonDown
|
Performs left mouse button down.
|
DoLButtonUp
|
Performs left mouse button up.
|
DoLClick
|
Performs a left click at the center of an object or at the specified location.
|
DoLDClick
|
Performs a left double click at the center of an object or at the specified location.
|
DoMButtonDown
|
Performs middle mouse button down.
|
DoMButtonUp
|
Performs middle mouse button up.
|
DoMClick
|
Performs a middle click at the center of an object or at the specified location.
|
DoMDClick
|
Performs a middle double click at the center of an object or at the specified location.
|
DoMouseMove
|
Moves mouse cursor to a location relative to this object position.
|
DoRButtonDown
|
Performs right mouse button down.
|
DoRButtonUp
|
Performs right mouse button up.
|
DoRClick
|
Performs a right click at the center of an object or at the specified location.
|
DoRDClick
|
Performs a right double click at the center of an object or at the specified location.
|
DoSendKeys
|
Sends series of keystrokes to an object.
|
Property Detail
Bitmap
UI Image of the object.
Accessors: GetBitmap
BWBitmap
UI Image of the object in 1-bit format (black&white).
Accessors: GetBWBitmap
Class
Class of the object.
Accessors: GetClass
Height
Height of the object.
Accessors: GetHeight
Name
Name of the object.
Accessors: GetName
ObjectType
SeSMatcherRule type for this object.
Accessors: GetObjectType
State
State of the object.
Accessors: GetState
Value
Value of the object.
Accessors: GetValue, SetValue
Width
Width of the object.
Accessors: GetWidth
WindowText
Window text of the object.
Accessors: GetWindowText, SetWindowText
X
X-coordinate of the top left corner of the object.
Accessors: GetX
Y
Y-coordinate of the top left corner of the object.
Accessors: GetY
Action Detail
DoAction()
Performs default action for an object. If the object doesn't have default action then 'LClick' is performed.
DoAnalogPlay(path, left, top)
Plays analog recording using coordinates relative to this object.
Parameters:
Name
|
Type
|
Description
|
path
|
string
|
Path to analog recording (usually an .arf file).
|
left
|
number
|
X-coordinate of top-left corner of the analog area, relative to object top-left corner
Optional.
|
top
|
number
|
Y-coordinate of the top-left corner of the analog area, relative to object top-left corner.
Optional.
|
DoClick(clickType, xOffset, yOffset)
Performs left click at the center of an object. It is a customizable variant of LClick action.
Parameters:
Name
|
Type
|
Description
|
clickType
|
string
|
Type of click, can be one of "L" - left click, "LD" - double left click, "R" - right click, "RD" - double right click, "M" - middle click, "MD" - double middle click, "N" - don't click
Optional, Default: L.
|
xOffset
|
number
|
X offset to click within object. Default is a center.
Optional.
|
yOffset
|
number
|
X offset to click within object. Default is a center.
Optional.
|
Returns:
'true' if operation is successful, 'false' otherwise
DoEnsureVisible()
Makes sure specified element is visible on the screen.
DoLButtonDown()
Performs left mouse button down. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: This action must be followed by 'DoLButtonUp', otherwise it may lock mouse cursor.
DoLButtonUp()
Performs left mouse button up. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: Use this action after 'DoLButtonDown', otherwise it will have no effect.
DoLClick(x, y)
Performs a left click at the center of an object or at the specified location.
Parameters:
Name
|
Type
|
Description
|
x
|
number
|
X-coordinate of location relative to object's left border
|
y
|
number
|
Y-coordinate of location relative to object's top border
|
Returns:
'true' if operation is successful, 'false' otherwise
DoLDClick(x, y)
Performs a left double click at the center of an object or at the specified location.
Parameters:
Name
|
Type
|
Description
|
x
|
number
|
X-coordinate of location relative to object's left border
|
y
|
number
|
Y-coordinate of location relative to object's top border
|
Returns:
'true' if operation is successful, 'false' otherwise
DoMButtonDown()
Performs middle mouse button down. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: This action must be followed by 'DoMButtonUp', otherwise it may lock mouse cursor.
DoMButtonUp()
Performs middle mouse button up. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: Use this action after 'DoMButtonDown', otherwise it will have no effect.
DoMClick(x, y)
Performs a middle click at the center of an object or at the specified location.
Parameters:
Name
|
Type
|
Description
|
x
|
number
|
X-coordinate of location relative to object's left border
|
y
|
number
|
Y-coordinate of location relative to object's top border
|
Returns:
'true' if operation is successful, 'false' otherwise
DoMDClick(x, y)
Performs a middle double click at the center of an object or at the specified location.
Parameters:
Name
|
Type
|
Description
|
x
|
number
|
X-coordinate of location relative to object's left border
|
y
|
number
|
Y-coordinate of location relative to object's top border
|
Returns:
'true' if operation is successful, 'false' otherwise
DoMouseMove(x, y)
Moves mouse cursor to a location relative to this object position.
Parameters:
Name
|
Type
|
Description
|
x
|
number
|
X-coordinate of location relative to object's left border
|
y
|
number
|
Y-coordinate of location relative to object's top border
|
DoRButtonDown()
Performs right mouse button down. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: This action must be followed by 'DoRButtonUp', otherwise it may lock mouse cursor.
DoRButtonUp()
Performs right mouse button up. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: Use this action after 'DoRButtonDown', otherwise it will have no effect.
DoRClick(x, y)
Performs a right click at the center of an object or at the specified location.
Parameters:
Name
|
Type
|
Description
|
x
|
number
|
X-coordinate of location relative to object's left border
|
y
|
number
|
Y-coordinate of location relative to object's top border
|
Returns:
'true' if operation is successful, 'false' otherwise
DoRDClick(x, y)
Performs a right double click at the center of an object or at the specified location.
Parameters:
Name
|
Type
|
Description
|
x
|
number
|
X-coordinate of location relative to object's left border
|
y
|
number
|
Y-coordinate of location relative to object's top border
|
Returns:
'true' if operation is successful, 'false' otherwise
DoSendKeys(keys)
Sends series of keystrokes to an object. For example: DoSendKeys('^F') - sends {CTRL} + {F}. See MSDN Article for SendKeys
Parameters:
Name
|
Type
|
Description
|
keys
|
string
|
A sequence of keystrokes.
|
|