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

ManagedMenuStrip

Top  Previous  Next

 

Managed MenuStrip. Extends ManagedObject. Extends SeSSimulatedObject.

 

Behavior Pattern: ManagedMenuBehavior

 

Action Summary

 

Action

Description

DoClickItem

Perform Click on the navigation item

DoFullText

Returns text representation of the menu or saves it to a file.

DoGetSubmenuCount

Gets the number of submenu items for a given menu path.

DoGetSubmenuProperty

Gets submenu property.

DoGetSubmenuText

Gets submenu text.

DoMenu

Performs click on the menu item.

 

Action Detail

 

DoClickItem(menuItemName)

Perform Click on the navigation item

 

Parameters:

 

Name

Type

Description

menuItemName

string

Name of MenuStip's item to click

 

Returns:

 

boolean: 'true' if success, 'false' otherwise.

 

DoFullText(separator, filePath, append, includeSeparators)

Returns text representation of the menu or saves it to a file.

 

Parameters:

 

Name

Type

Description

separator

string

Separator character.
Optional, Default: ;.

filePath

string

Name of a file that should hold text representation of the menu.

append

boolean

If 'false' then file should be overwritten, if 'true' then data should be appended.
Optional, Default: false.

includeSeparators

boolean

If 'true' then menu separators are included to the result.
Optional, Default: false.

 

Returns:

 

number |
boolean: Text representation of the menu, 'true' if the file was successfully written, 'false' otherwise.

 

DoGetSubmenuCount(path, separator)

Gets the number of submenu items for a given menu path.

 

Parameters:

 

Name

Type

Description

path

string

Path from the menu root to a leaf item with components delimited by separator parameter.

separator

string

Separator character.
Optional, Default: ;.

 

Returns:

 

number |
boolean: Number of submenu items, 'false' otherwise.

 

DoGetSubmenuProperty(path, index, property, separator)

Gets submenu property.

 

Parameters:

 

Name

Type

Description

path

string

Path from the menu root to a leaf item with components delimited by separator parameter.

index

number

Index of the submenu.

property

string

Name of a property. Available properties can be seen in Java Spy.

separator

string

Separator character.
Optional, Default: ;.

 

Returns:

 

string |
boolean: Submenu property, 'false' otherwise.

 

DoGetSubmenuText(path, index, separator)

Gets submenu text.

 

Parameters:

 

Name

Type

Description

path

string

Path from the menu root to a leaf item with components delimited by separator parameter.

index

number

Index of the submenu.

separator

string

Separator character.
Optional, Default: ;.

 

Returns:

 

string |
boolean: Submenu text, 'false' otherwise.

 

DoMenu(path, separator)

Performs click on the menu item.

 

Parameters:

 

Name

Type

Description

path

string

Path from the menu root to a leaf item with components delimited by separator parameter.

separator

string

Separator character.
Optional, Default: ;.

 

Returns:

 

boolean: 'true' if success, 'false' otherwise.