SAPGuiToolbar Object

Description

A toolbar in an SAP GUI for Windows application.

Operations

The sections below list the built-in methods and properties that you can use as operations for the SAPGuiToolbar object.

Note: You can also view a list and descriptions of the SAPGuiToolbar description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PressButtonPresses the specified toolbar button.
Method PressContextButtonPresses the specified toolbar button to open the button's context menu.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SelectMenuItemSelects the specified menu item from the toolbar button context menu.
Method SelectMenuItemByIdSelects the specified menu item from the toolbar button context menu based on its SAP ID.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the object.

Back to top

 

PressButton Method

Description

Presses the specified toolbar button.

Syntax

object.PressButton (Button)

Arguments

ParameterDescription
Button Required. A String value.
The button's ID.

Return Type

None.

Example

Back to top

 

PressContextButton Method

Description

Presses the specified toolbar button to open the button's context menu.

Syntax

object.PressContextButton (Button)

Arguments

ParameterDescription
Button Required. A String value.
The button's ID.

Return Type

None.

IMPORTANT

Although UFT One successfully records and runs steps performed on context menus, the context menu is not displayed in the Active Screen or in your application during the test run.

Example

Back to top

 

SelectMenuItem Method

Description

Selects the specified menu item from the toolbar button context menu.

Syntax

object.SelectMenuItem (Path)

Arguments

ParameterDescription
Path Required. A String value.
The menu item name, full path, or numeric index can denote the item. Index values begin with 1.
For a full path, separate items with semicolons (;).

Return Type

None.

IMPORTANT

This method is recorded only for toolbar context menus that send an event corresponding to the PressContextButton method.

This method is supported only for separate toolbars. It is not supported for toolbars in grid controls.

Although UFT One successfully records and runs steps performed on context menus, the context menu is not displayed in the Active Screen or in your application during the test run.

Example

Back to top

 

SelectMenuItemById Method

Description

Selects the specified menu item from the toolbar button context menu based on its SAP ID.

Syntax

object.SelectMenuItemById (Id)

Arguments

ParameterDescription
Id Required. A String value.
The SAP ID of the context menu item.

Return Type

None.

IMPORTANT

This method is recorded for separate toolbar context menus that do not send an event corresponding to the PressContextButton method and for all toolbars inside grid controls. For these objects, neither a PressContextButton nor PressButton method is recorded before the SelectMenuItemById method.

Example

Back to top

See also: