Object Model Reference for GUI Testing > Siebel > ActivateRow Method

SblTable Object

Description

A Siebel table containing a variable number of rows and columns.

Operations

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

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

Method ActivateRow Activates the specified table row.
Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks the object.
Method ColumnCount Returns the number of columns in a specified row.
Method ColumnExists Indicates whether the specified column exists in the table.
Method Drag Performs the 'drag' part of a drag and drop operation.
Method DrillDown Drills down the specified table cell's link.
Method Drop Performs the 'drop' part of a drag and drop operation.
Method FireEvent Triggers an event.
Method GetCellData Returns the text for a specified cell.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method IsColumnWritable Returns the state of table column, where state is the value of the column's disabled or read-only property.
Method MiddleClick Middle-clicks the object.
Method OpenCellElement Clicks on the element inside the specified cell.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method RightClick Right-clicks the object.
Method RowCount Returns the number of rows in a table.
Method ScrollRows Scrolls the rows of the table up or down.
Method SelectCell Clicks on the cell with the specified coordinates.
Method SetCellData Sets the value of the input in the given cell.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method SortDown Sorts the table in descending order based on the contents of the specified column.
Method SortUp Sorts the table in ascending order based on the contents of the specified column.
Method Submit Submits a form.
Common Method ToString Returns a string that represents the test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.

 

Back to top

ActivateRow Method

Description

Activates the specified table row.

Syntax

object.ActivateRow (Row)

Arguments

Parameter Description
Row Required. A long integer value.
The number of the row to activate. The first row in the table is numbered 1. (Keep in mind that row 1 of a table is the header row.)

Return Type

None.

Example


 

Back to top

Click Method

Description

Clicks the object.

Syntax

object.Click [x], [y], [BUTTON]

Arguments

Parameter Description
x Optional. A long integer value.
The x-coordinate of the click, relative to the upper-left corner of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate of the click, relative to the upper-left corner of the object.
Default value = -9999
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

ColumnCount Method

Description

Returns the number of columns in a specified row.

Syntax

object.ColumnCount (Row)

Arguments

Parameter Description
Row Required. A long integer value.
The row number.  (The first row in the table is numbered 1.)

Return Type

A long integer value.

Example


 

Back to top

ColumnExists Method

Description

Indicates whether the specified column exists in the table.

Syntax

object.ColumnExists (Column)

Arguments

Parameter Description
Column Required. A Variant.
The column number or column header label.  (The first column in the table is numbered 1.)

Return Type

A Boolean value.

Example


 

Back to top

Drag Method

Description

Performs the 'drag' part of a drag and drop operation.

Syntax

object.Drag [x], [y], [BUTTON], [Modifier]

Arguments

Parameter Description
x Optional. A long integer value.
The x-coordinate within the source object. 

Default = micNoCoordinate (center of the source object)


Default value = -9999
y Optional. A long integer value.
The y-coordinate within the source object.

Default = micNoCoordinate (center of the source object)


Default value = -9999
BUTTON Optional. A predefined constant or number.
The mouse button used to drag the object. (Releasing the button performs the Drop operation.)

Default = micLeftBtn (0)


Default value = micLeftBtn
Modifier Optional. A String value.

The keyboard modifier that is pressed during the Drag operation.

Possible values:
micAlt
micCtrl
micShift


Default value = 0

Return Type

None

IMPORTANT

Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur in the run session.

UFT supports the following scenarios:

General Note:

UFT always runs Drag and Drop steps using the mouse API, even if you defined the Replay type as Event in the Run settings section of the Web > Advanced pane (Tools > Options > GUI Testing tab >Web pane > Advanced node). 

 

Notes for Scenario A:

--Recording session. You cannot record cross-object or cross-frame types of drag and drop operations (operations in which you try to drop an object on another object or in another frame). You can, however, insert these types of Drop steps manually. Note that it may be helpful to record a drag and drop operation on the object in order to determine valid coordinates for the Drag operation step. You will need to delete the recorded Drop step, though, and manually add a new Drop step for the target object instead. 

--Run session. If the application being tested supports scrolling, then UFT supports scrolling when the Drag and Drop test objects are both located in the same frame. UFT drags the Drag object to edge of the frame, waits for the Drop object to appear, and drops the Drag object onto the Drop object. If the application being tested does not support scrolling, then UFT displays an error message when it reaches a step that requires scrolling. 

--Run session. If you want to drag a test object from one frame to another, UFT tries to make both the Drag and Drop objects visible in their frames prior to performing the Drag and Drop operation. If the two objects cannot be viewed simultaneously (for example, because the browser window is too small), the step will fail.

Notes for Scenario B and Scenario C:

--If the screen resolution during a run session is not the same as the screen resolution during the recording session, then the size of the frame may be different during the run session as compared to the recording session. In this case, the target location coordinates may be different during the run session, and this may cause the test steps to fail.

--During a run session, if the coordinates of a Drop step are located outside of the visible frame area (for example, because your application changed), then the step may not run accurately. To solve this, fix the specified coordinates, as needed. The test object can be dragged only within the visible area of the frame object. Dragging the object to the edge of a window or frame does not cause the area to scroll (as it does in Scenario A).

Example


 

Back to top

DrillDown Method

Description

Drills down the specified table cell's link.

Syntax

object.DrillDown (Row, Column)

Arguments

Parameter Description
Row Required. A long integer value.
The row number where the cell is located.  The first row in the table is numbered 1. (Keep in mind that row 1 of a table is the header row.)
Column Required. A Variant.
The column number or column header label where the cell is located.  The first column in the table is numbered 1. (Keep in mind that the first 1 or 2 columns of your table may be header columns and that the first column with a value may be column 2 or 3.)

Return Type

None.


 

Back to top

Drop Method

Description

Performs the 'drop' part of a drag and drop operation.

Syntax

object.Drop [x], [y]

Arguments

Parameter Description
x Optional. A long integer value.
The x-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the the x-coordinate is relative to the upper left corner in the source location prior to being dragged.

Default = micNoCoordinate (center of the target object)


Default value = -9999
y Optional. A long integer value.
The y-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the the y-coordinate is relative to the upper left corner in the source location prior to being dragged.

Default = micNoCoordinate (center of the target object)


Default value = -9999

Return Type

None

IMPORTANT

Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur. For more information on Drag and Drop operations, see Drag Method.

Example


 

Back to top

FireEvent Method

Description

Triggers an event.

Syntax

object.FireEvent EventName, [x], [y], [BUTTON]

Arguments

ParameterDescription
EventName Required. A String value.
The name of the event to trigger. All events exposed by the Dynamic HTML (DHTML) Object Model are supported. Refer to the DHTML Events section of the MSDN Library documentation for further information.
x Optional. A long integer value.
The x-coordinate, relative to the upper-left corner of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate, relative to the upper-left corner of the object.
Default value = -9999
BUTTON Optional. A predefined constant or number.
The mouse button used to fire the event.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

GetCellData Method

Description

Returns the text for a specified cell.

Syntax

object.GetCellData (Row, Column)

Arguments

ParameterDescription
Row Required. A long integer value.
The row number where the cell is located.  (The first row in the table is numbered 1.)
Column Required. A Variant.
The column number or column header label where the cell is located.  (The first column in the table is numbered 1.)

Return Type

A String value.

Example


 

Back to top

IsColumnWritable Method

Description

Returns the state of table column, where state is the value of the column's disabled or read-only property.

Syntax

object.IsColumnWritable (Column)

Arguments

ParameterDescription
Column Required. A Variant.
The column number or column header label.
(The first column in the table is numbered 1.)

Return Type

A Boolean value.

Example


 

Back to top

MiddleClick Method

Description

Middle-clicks the object.

Syntax

object.MiddleClick [x], [y]

Arguments

ParameterDescription
x Optional. A long integer value.
The x-coordinate of the middle-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate of the middle-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999

Return Type

None


 

Back to top

OpenCellElement Method

Description

Clicks on the element inside the specified cell.

Syntax

object.OpenCellElement (Row, Column)

Arguments

ParameterDescription
Row Required. A long integer value.
The row number where the cell is located.
(The first row in the table is numbered 1.)
Column Required. A Variant.
The column number or column header label where the cell is located.
(The first column in the table is numbered 1.)

Return Type

None.

IMPORTANT

The element may be a link or an image of a SiebelFuncEdit object.

Example


 

Back to top

RightClick Method

Description

Right-clicks the object.

Syntax

object.RightClick [x], [y]

Arguments

ParameterDescription
x Optional. A long integer value.
The x-coordinate of the right-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate of the right-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999

Return Type

None


 

Back to top

RowCount Method

Description

Returns the number of rows in a table.

Syntax

object.RowCount

Return Type

A long integer value.

Example


 

Back to top

ScrollRows Method

Description

Scrolls the rows of the table up or down.

Syntax

object.ScrollRows (Number, Direction)

Arguments

ParameterDescription
Number Required. A long integer value.
The number of rows to scroll.
Direction Required. A String value.
The direction in which to scroll.
Possible values:
       Up
       Down

Return Type

None.

IMPORTANT

When recording, it records the scrolling of one row for each click on the scroll bar. When entering a ScrollRows statement manually, you can specify the number of rows you want to scroll.

Example


 

Back to top

SelectCell Method

Description

Clicks on the cell with the specified coordinates.

Syntax

object.SelectCell (Row, Column)

Arguments

ParameterDescription
Row Required. A long integer value.
The row number.
(The first row in the table is numbered 1.)
Column Required. A Variant.
The column number or the column header label.
(The first column in the table is numbered 1.)

Return Type

None.

Example


 

Back to top

SetCellData Method

Description

Sets the value of the input in the given cell.

Syntax

object.SetCellData (Row, Column, Data)

Arguments

ParameterDescription
Row Required. A long integer value.
The row number.
(The first row in the table is numbered 1.)
Column Required. A Variant.
The column number or the column header label.
(The first column in the table is numbered 1.)
Data Required. A String value.
The value to be set in the specified cell.

Return Type

None.

IMPORTANT

The cell data may be contained in an edit box, combo box, or check box.

Example


 

Back to top

SortDown Method

Description

Sorts the table in descending order based on the contents of the specified column.

Syntax

object.SortDown (Column)

Arguments

ParameterDescription
Column Required. A Variant.
The column number or the header label. (The first column in the table is numbered 1.)

Return Type

None.

Example


 

Back to top

SortUp Method

Description

Sorts the table in ascending order based on the contents of the specified column.

Syntax

object.SortUp (Column)

Arguments

ParameterDescription
Column Required. A Variant.
The column number or the header label. (The first column in the table is numbered 1.)

Return Type

None.

Example


 

Back to top

Submit Method

Description

Submits a form.

Syntax

object.Submit

Return Type

None.

IMPORTANT

This method simulates pressing the Enter key, while the focus is on the object specified in the statement.

If the object is not part of a form, the Submit method has no effect.

Example


Back to top

See also: