Skip to content

SeSSimulatedObject

Generic SeSSimulated. 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.
DoSendText Sends text to the active application as is (while SendKeys also supports sending special keys).

Property Detail

Bitmap

UI Image of the object.

Type: ImageWrapper

Accessors: GetBitmap

value = SeS('SomeSeSSimulatedObject').GetBitmap()

BWBitmap

UI Image of the object in 1-bit format (black&white).

Type: ImageWrapper

Accessors: GetBWBitmap

value = SeS('SomeSeSSimulatedObject').GetBWBitmap()

Class

Class of the object.

Type: string

Accessors: GetClass

value = SeS('SomeSeSSimulatedObject').GetClass()

Height

Height of the object.

Type: number

Accessors: GetHeight

value = SeS('SomeSeSSimulatedObject').GetHeight()

Name

Name of the object.

Type: string

Accessors: GetName

value = SeS('SomeSeSSimulatedObject').GetName()

ObjectType

SeSMatcherRule type for this object.

Type: string

Accessors: GetObjectType

value = SeS('SomeSeSSimulatedObject').GetObjectType()

State

State of the object.

Type: string

Accessors: GetState

value = SeS('SomeSeSSimulatedObject').GetState()

Value

Value of the object.

Type: string

Accessors: GetValue, SetValue

value = SeS('SomeSeSSimulatedObject').GetValue()

SeS('SomeSeSSimulatedObject').SetValue(value)

Width

Width of the object.

Type: number

Accessors: GetWidth

value = SeS('SomeSeSSimulatedObject').GetWidth()

WindowText

Window text of the object.

Type: string

Accessors: GetWindowText, SetWindowText

value = SeS('SomeSeSSimulatedObject').GetWindowText()

SeS('SomeSeSSimulatedObject').SetWindowText(value)

X

X-coordinate of the top left corner of the object.

Type: number

Accessors: GetX

value = SeS('SomeSeSSimulatedObject').GetX()

Y

Y-coordinate of the top left corner of the object.

Type: number

Accessors: GetY

value = SeS('SomeSeSSimulatedObject').GetY()

Action Detail

DoAction

Performs default action for an object. If the object doesn't have default action then 'LClick' is performed.

SeS('SomeSeSSimulatedObject').DoAction()

DoAnalogPlay

Plays analog recording using coordinates relative to this object.

SeS('SomeSeSSimulatedObject').DoAnalogPlay(path, left, top)

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

Performs left click at the center of an object. It is a customizable variant of LClick action.

SeS('SomeSeSSimulatedObject').DoClick(clickType, xOffset, yOffset)

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 Possible values: "L", "LD", "R", "RD", "M", "MD", "N"
Optional, Default: "L".
xOffset number X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width.
Optional.
yOffset number Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height.
Optional.

Returns:

boolean: 'true' if operation is successful, 'false' otherwise

DoEnsureVisible

Makes sure specified element is visible on the screen.

SeS('SomeSeSSimulatedObject').DoEnsureVisible()

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.

SeS('SomeSeSSimulatedObject').DoLButtonDown()

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.

SeS('SomeSeSSimulatedObject').DoLButtonUp()

DoLClick

Performs a left click at the center of an object or at the specified location.

SeS('SomeSeSSimulatedObject').DoLClick(x, y)

Parameters:

Name Type Description
x number X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width.
Optional.
y number Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height.
Optional.

Returns:

boolean: 'true' if operation is successful, 'false' otherwise

DoLDClick

Performs a left double click at the center of an object or at the specified location.

SeS('SomeSeSSimulatedObject').DoLDClick(x, y)

Parameters:

Name Type Description
x number X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width.
Optional.
y number Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height.
Optional.

Returns:

boolean: '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.

SeS('SomeSeSSimulatedObject').DoMButtonDown()

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.

SeS('SomeSeSSimulatedObject').DoMButtonUp()

DoMClick

Performs a middle click at the center of an object or at the specified location.

SeS('SomeSeSSimulatedObject').DoMClick(x, y)

Parameters:

Name Type Description
x number X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width.
Optional.
y number Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height.
Optional.

Returns:

boolean: 'true' if operation is successful, 'false' otherwise

DoMDClick

Performs a middle double click at the center of an object or at the specified location.

SeS('SomeSeSSimulatedObject').DoMDClick(x, y)

Parameters:

Name Type Description
x number X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width.
Optional.
y number Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height.
Optional.

Returns:

boolean: 'true' if operation is successful, 'false' otherwise

DoMouseMove

Moves mouse cursor to a location relative to this object position.

SeS('SomeSeSSimulatedObject').DoMouseMove(x, y, duration)

Parameters:

Name Type Description
x number X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width.
Optional.
y number Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height.
Optional.
duration number Mouse move duration (milliseconds). If 0 - do immediate move.
Optional, Default: "0".

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.

SeS('SomeSeSSimulatedObject').DoRButtonDown()

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.

SeS('SomeSeSSimulatedObject').DoRButtonUp()

DoRClick

Performs a right click at the center of an object or at the specified location.

SeS('SomeSeSSimulatedObject').DoRClick(x, y)

Parameters:

Name Type Description
x number X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width.
Optional.
y number Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height.
Optional.

Returns:

boolean: 'true' if operation is successful, 'false' otherwise

DoRDClick

Performs a right double click at the center of an object or at the specified location.

SeS('SomeSeSSimulatedObject').DoRDClick(x, y)

Parameters:

Name Type Description
x number X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width.
Optional.
y number Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height.
Optional.

Returns:

boolean: 'true' if operation is successful, 'false' otherwise

DoSendKeys

Sends series of keystrokes to an object. For example: DoSendKeys('^F') - sends {CTRL} + {F}. See MSDN Article for SendKeys

SeS('SomeSeSSimulatedObject').DoSendKeys(keys)

Parameters:

Name Type Description
keys string A sequence of keystrokes.

DoSendText

Sends text to the active application as is (while SendKeys also supports sending special keys).

SeS('SomeSeSSimulatedObject').DoSendText(text)

Parameters:

Name Type Description
text string A sequence of keystrokes.