This page is maintained for older versions of Rapise only. The latest documentation can be found at: https://rapisedoc.inflectra.com
ManagedObject

ManagedObject

Top  Previous  Next

 

Generic .NET Managed Object. Extends SeSSimulatedObject.

 

Behavior Pattern: ManagedObjectGenericBehavior

 

Property Summary

 

Property

Description

Getter

Setter

ControlType

Type of the object.

GetControlType


Height

Height of the object.

GetHeight


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

DoDumpWidget

Dumps Spy data for the object.

DoFindByName

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

DoFindByText

Find nested element by its text (Value, 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

 

ControlType

Type of the object.

Accessors: GetControlType

 

Height

Height of the object.

Accessors: GetHeight

 

Width

Width of the object.

Accessors: GetWidth

 

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

 

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:

 

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

 

DoFindByName(textOrRegexp, depth)

Find nested element by its text (Value, 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 containing text if found, null otherwise

 

DoFindByText(textOrRegexp, depth)

Find nested element by its text (Value, 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 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:

 

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