SAPGuiComboBox Object

Description

A combo box 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 SAPGuiComboBox object.

Note: You can also view a list and descriptions of the SAPGuiComboBox 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.

Method GetItemReturns the value of the item specified by the index.
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.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SelectSelects an item from the combo box list.
Method SelectKeySelects the SAP (shortcut) key representing an item in the combo box list.
Method SetFocusSets the focus on a combo box object in an SAP GUI for Windows application.
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

 

GetItem Method

Description

Returns the value of the item specified by the index.

Syntax

object.GetItem (Index)

Arguments

ParameterDescription
Index Required. A long integer value.
Numeric index of the item. Index values begin with 1.

Return Type

A Variant.

IMPORTANT

This method is not recorded. To add this method to your test, use the Step Generator or enter it manually in the Keyword View or Editor. For more information, see the UFT One User Guide.

Example

Back to top

 

Select Method

Description

Selects an item from the combo box list.

Syntax

object.Select (Value)

Arguments

ParameterDescription
Value Required. A String value.
The item to select from the list. The item can be the name or the index (in the format "#index").
Index values begin with 1.

Return Type

None.

Example

Back to top

 

SelectKey Method

Description

Selects the SAP (shortcut) key representing an item in the combo box list.

Syntax

object.SelectKey (Key)

Arguments

ParameterDescription
Key Required. A String value.
The SAP (shortcut) key representing the item to select.
Tip: You can find the value of an item key by using the Object Spy to view the selected Key property. For more information, see the UFT One User Guide.

Return Type

None.

IMPORTANT

This method is not recorded. To add this method to your test, use the Step Generator or enter it manually in the Keyword View or Editor. For more information, see the UFT One User Guide.

Example

Back to top

 

SetFocus Method

Description

Sets the focus on a combo box object in an SAP GUI for Windows application.

Syntax

object.SetFocus

Return Type

None.

IMPORTANT

This method is recorded on the object that has the focus when information is sent to the SAP server during a recording session. This ensures that the focus is on the correct object during the test run.

Example

Back to top

See also: