UIAObject

Extends SeSSimulatedObject

Behavior Pattern: UIAObjectGenericBehavior

Property Summary

Property Description Getter Setter
AutomationId Automation ID of UI Automation object GetAutomationId
ChildAt Object for nth child of this object's UI Automation node GetChildAt
ChildrenCount Number of UI Automation nodes within current node GetChildrenCount
Height Height of the object. GetHeight
IndexInParent Object's order index in parent UI Automation node GetIndexInParent
Name Name of of UI Automation object GetName
NextSibling Object for UI Automation next sibling node GetNextSibling
Parent Object for UI Automation parent node GetParent
PrevSibling Object for UI Automation previous sibling node GetPrevSibling
TypeName Type name of UI Automation object GetTypeName
Value Value of the object. GetValue
Width Width of the object. GetWidth
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
DoClick Performs left click at the center of an object.
DoDumpWidget Dumps Spy data for the object.
DoFindByText Find nested element by its text (Value and Name of each element are compared with specified text or regular expression).
DoGetWidgetProperty Returns the value of a property with a given name.

Property Detail

AutomationId

Automation ID of UI Automation object

Type: string

Accessors: GetAutomationId

ChildAt

Object for nth child of this object's UI Automation node

Getter Parameters:

Name Type Description
ind=0 number Zero-based index for a required child

Type: object

Accessors: GetChildAt

ChildrenCount

Number of UI Automation nodes within current node

Type: number

Accessors: GetChildrenCount

Height

Height of the object.

Type: number

Accessors: GetHeight

IndexInParent

Object's order index in parent UI Automation node

Type: number

Accessors: GetIndexInParent

Name

Name of of UI Automation object

Type: string

Accessors: GetName

NextSibling

Object for UI Automation next sibling node

Type: object

Accessors: GetNextSibling

Parent

Object for UI Automation parent node

Type: object

Accessors: GetParent

PrevSibling

Object for UI Automation previous sibling node

Type: object

Accessors: GetPrevSibling

TypeName

Type name of UI Automation object

Type: String

Accessors: GetTypeName

Value

Value of the object.

Type: number

Accessors: GetValue

Width

Width of the object.

Type: number

Accessors: GetWidth

X

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

Type: number

Accessors: GetX

Y

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

Type: number

Accessors: GetY

Action Detail

DoClick(x, y)

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

Parameters:

Name Type Description
x number X offset to click within object. Default is a center.
Optional.
y number Y offset to click within object. Default is a center.
Optional.

DoDumpWidget(dumpProperties, maxDepth, trimValue, indent, filePath, append, ignoreProps)

Dumps Spy data for the object.

Parameters:

Name Type Description
dumpProperties boolean If 'true' then includes properties to the result.
Optional, Default: false.
maxDepth number Determines max recursion depth. If '0' then dumps current object only, if '1' - dumps direct children as well, etc. If '-1' then dumps the whole subtree of objects.
Optional, Default: 0.
trimValue number Determines maximum length of a proprty value. Excess characters are truncated.
Optional, Default: 256.
indent string Indentation string for child objects and properties.
Optional, Default: .
filePath string If 'filePath' is set then outputs result to corresponding file.
Optional.
append boolean If 'true' then file should be overwritten, if 'false' then data should be appended.
Optional, Default: false.
ignoreProps Array Contains the names of the properties which must be ignored when writing into a file.
Optional, Default: undefined.

Returns:

string |
boolean: Object data if 'filePath' is not set, 'true' if file write succeeded, 'false' - otherwise.

DoFindByText(textOrRegexp, depth)

Find nested element by its text (Value and Name of each element are compared with specified text or regular expression).

Parameters:

Name Type Description
textOrRegexp string plain string or regexp:... expression to match
depth number depth level for search (default is 3)
Optional, Default: 3.

Returns:

object: UIAutomationObject containing text if found, null otherwise

DoGetWidgetProperty(name)

Returns the value of a property with a given name. Names of available properties can be seen in Spy.

Parameters:

Name Type Description
name string Property name.

Returns:

string: Property value if successful, an empty string if the property can not be found.