Object Model Reference for GUI Testing > .NET Web Forms > ActivateCell Method

WbfUltraGrid Object

Description

A .NET Web Forms UltraGrid object.

Operations

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

Note: You can also view a list and descriptions of the WbfUltraGrid 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 ActivateCell Double-clicks the specified cell in the grid.
Method AddRow Adds a new empty row to the grid.
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 CollapseRow Collapses the specified row.
Method ColumnCount Returns the number of columns in the outermost table.
Method DeleteRow Deletes a row from the grid.
Method DoubleClick Clicks on the object twice.
Method Drag Performs the 'drag' part of a drag and drop operation.
Method Drop Performs the 'drop' part of a drag and drop operation.
Method ExpandRow Expands the specified row.
Method FireEvent Triggers an event.
Method GetCellData Retrieves the contents of the specified cell from a table.
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 GroupRows Groups grid rows by the specified columns.
Method HoverTap When hover is supported, places the pointer on the object. Otherwise, taps the object.
Method LongPress Presses and holds the object.
Method MiddleClick Middle-clicks the object.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method Pan Perform a pan gesture.
Method Pinch Perform a pinch gesture.
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 the outermost table.
Method SelectCell Double-clicks the specified cell in the grid.
Method SelectColumn Selects (clicks) the specified column in the grid.
Method SelectRow Selects (clicks) the specified row in the grid.
Method SetCellData Sets the contents of a cell to the specified text in the grid.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method Sort Sorts the grid by the specified columns.
Method Submit Submits a form.
Method Swipe Swipes the object.
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

ActivateCell Method

Description

Double-clicks the specified cell in the grid.

Syntax

object.ActivateCell (row_path, col_path)

Arguments

Parameter Description
row_path Required. A Variant.
The location of the row within the grid.
Specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
col_path Required. A Variant.
The location of the column within the grid.
For Infragistics UltraWinGrid, use the column header name or the column index (0-based).

Return Type

None.

Example


 

Back to top

AddRow Method

Description

Adds a new empty row to the grid.

Syntax

object.AddRow (table_name)

Arguments

Parameter Description
table_name Required. A String value.

The name of the band to which you want to add a row. This name is usually the same as the name of the Add button.

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. Note that 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 click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Tip: You can enter micNoCoordinate for the x and y argument values if you want to enter a value for the button argument without specifying x- and y- coordinates for the click.
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

CollapseRow Method

Description

Collapses the specified row.

Syntax

object.CollapseRow (row_path)

Arguments

Parameter Description
row_path Required. A Variant.
The location of the row within the grid.
Specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.

Return Type

None.

Example


 

Back to top

ColumnCount Method

Description

Returns the number of columns in the outermost table.

Syntax

object.ColumnCount

Return Type

A long integer value.

IMPORTANT

The outermost table is the table that is not nested within any other table.

Example


 

Back to top

DeleteRow Method

Description

Deletes a row from the grid.

Syntax

object.DeleteRow (row_path)

Arguments

Parameter Description
row_path Required. A Variant.
The location of the row within the grid.
Specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.

Return Type

None.

Example


 

Back to top

DoubleClick Method

Description

Clicks on the object twice.

Syntax

object.DoubleClick ([interval], [x], [y])

Arguments

Parameter Description
interval Optional. A double floating value.
The number of seconds between the two clicks. The default value is 0.2 seconds.

Default value = 0.200000002980232
x Optional. A long integer value.
The x-coordinate of the 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 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.

IMPORTANT

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.

Default value = -9999
y Optional. A long integer value.

Default value = -9999
BUTTON Optional. A predefined constant or number.

Default value = micLeftBtn
Modifier Optional. A String value.

Default value = 0

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.

Default value = -9999
y Optional. A long integer value.

Default value = -9999

Return Type

None


 

Back to top

ExpandRow Method

Description

Expands the specified row.

Syntax

object.ExpandRow (row_path)

Arguments

Parameter Description
row_path Required. A Variant.
The location of the row within the grid.
Specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.

Return Type

None.

Example


 

Back to top

FireEvent Method

Description

Triggers an event.

Syntax

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

Arguments

Parameter Description
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 object.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

GetCellData Method

Description

Retrieves the contents of the specified cell from a table.

Syntax

object.GetCellData (row_path, col_path)

Arguments

Parameter Description
row_path Required. A Variant.

The location of the row within the grid.

For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
col_path Required. A Variant.
The location of the column within the grid.  Use the column header name or the column index (0-based).

Return Type

A String value.

Example


 

Back to top

GroupRows Method

Description

Groups grid rows by the specified columns.

Syntax

object.GroupRows (col_path)

Arguments

Parameter Description
col_path Required. A Variant.
The location of the column within the grid.
Use the format:
       n;name
where n is the band level (0-based) and name is the column header name or the column index (0-based).

Return Type

None.

IMPORTANT

This method is not recorded. You can include it in your test or component by inserting it directly in the Keyword View or Editor, or by using the Step Generator. For more information about inserting steps while editing your test or component, see the Unified Functional Testing User Guide.

Example


 

Back to top

HoverTap Method

Description

When hover is supported, places the pointer on the object. Otherwise, taps the object.

Syntax

object.HoverTap ([x], [y])

Arguments

Parameter Description
x Optional. A long integer value.
The x-coordinate of the hover point or tap. 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 hover point or tap. 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.

IMPORTANT

This method is supported as long as the Web site being tested is run on a mobile device on Mobile Center, and the test object implements this gesture. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

Example


 

Back to top

LongPress Method

Description

Presses and holds the object.

Syntax

object.LongPress [duration], [x], [y]

Arguments

Parameter Description
duration Optional. A double floating value.

The time period (in seconds) to hold the long tap gesture.

You can specify partial seconds as a duration time.


Default value = 1
x Optional. A long integer value.
The x-coordinate of the tap gesture. The coordinate is 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 tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.


 

Back to top

MiddleClick Method

Description

Middle-clicks the object.

Syntax

object.MiddleClick [x], [y]

Arguments

Parameter Description
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

Pan Method

Description

Perform a pan gesture.

Syntax

object.Pan (deltaX, deltaY, [duration], [startX], [startY])

Arguments

Parameter Description
deltaX Required. A long integer value.
The distance moved on the x axis, relative to the start point.
deltaY Required. A long integer value.
The distance moved on the y axis, relative to the start point.
duration Optional. A double floating value.

The number of seconds required to perform the pan gesture.


Default value = 0.5
startX Optional. A long integer value.

The x-coordinate of where the pan gesture starts. 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
startY Optional. A long integer value.

The y-coordinate of where the pan gesture starts. 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.

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported in Internet Explorer and older versions of FireFox

Example


 

Back to top

Pinch Method

Description

Perform a pinch gesture.

Syntax

object.Pinch (scale, [duration], [x], [y])

Arguments

Parameter Description
scale Required. A double floating value.

The zoom scale resulting from the pinch gesture.

This is the ratio between the distance between the fingers at the end of the pinch gesture to the distance between the fingers at the beginning of the pinch gesture.

duration Optional. A double floating value.

The number of seconds required to perform the pinch gesture. The default value is 1 second.


Default value = 1
x Optional. A long integer value.

The x-coordinate of where the pinch gesture begins. 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 of where the pinch gesture begins. 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.

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported in Internet Explorer and older versions of FireFox.

Example


 

Back to top

RightClick Method

Description

Right-clicks the object.

Syntax

object.RightClick [x], [y]

Arguments

Parameter Description
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 the outermost table.

Syntax

object.RowCount

Return Type

A long integer value.

IMPORTANT

The outermost table is the table that is not nested within any other table.

Example


 

Back to top

SelectCell Method

Description

Double-clicks the specified cell in the grid.

Syntax

object.SelectCell (row_path, col_path)

Arguments

Parameter Description
row_path Required. A Variant.
The location of the row within the grid.
Specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
col_path Required. A Variant.
The location of the column within the grid. Use the column header name or the column index (0-based).

Return Type

None.

Example


 

Back to top

SelectColumn Method

Description

Selects (clicks) the specified column in the grid.

Syntax

object.SelectColumn (col_path, [is_cumulative])

Arguments

Parameter Description
col_path Required. A Variant.
The location of the column within the grid.
Use the format:
       n;name
where n is the band level (0-based) and name is the column header name or the column index (0-based).
is_cumulative Optional. A Boolean value.

Defines whether the specified column should be selected in addition to any currently selected column(s) or instead of any currently selected column(s).
Possible values:                                    
       True
       False   (default)


Default value = False

Return Type

None.

Example


 

Back to top

SelectRow Method

Description

Selects (clicks) the specified row in the grid.

Syntax

object.SelectRow (row_path, [is_cumulative])

Arguments

Parameter Description
row_path Required. A Variant.
The location of the row within the grid.
Specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
is_cumulative Optional. A Boolean value.
Defines whether the specified row should be selected in addition to any currently selected row(s) or instead of any currently selected row(s).
Possible values:                                    
       True
       False   (default)

Default value = False

Return Type

None.

Example


 

Back to top

SetCellData Method

Description

Sets the contents of a cell to the specified text in the grid.

Syntax

object.SetCellData (row_path, col_path, Data, [Index])

Arguments

Parameter Description
row_path Required. A Variant.
The location of the row within the grid.
Specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
col_path Required. A Variant.

The location of the column within the grid. Use the column header name or the column index (0-based).

Data Required. A String value.

The data to set for the control.
Possible values:                                    
       On
       Off

Index Optional. A long integer value.
The index of the control within the cell. The first object has an index of 1.
Default value = -1

Return Type

None.

IMPORTANT

This method is recorded only after you move the focus from the edited cell to another cell.

Example


 

Back to top

Sort Method

Description

Sorts the grid by the specified columns.

Syntax

object.Sort (col_path, Order, [is_cumulative])

Arguments

Parameter Description
col_path Required. A Variant.
The location of the column within the grid.
Use the format:
       n;name
where n is the band level (0-based) and name is the column header name or the column index (0-based).
Order Required. A Variant.
The sorting order.
Possible values:                                    
       True
  (descending) (default)
       False (ascending)
is_cumulative Optional. A Boolean value.
Specifies whether the sort should be performed according to multiple selected columns.
Possible values:                                    
       True
       False   (default)

Default value = False

Return Type

None.

Example


 

Back to top

Submit Method

Description

Submits a form.

Syntax

object.Submit

Return Type

None.

Example


 

Back to top

Swipe Method

Description

Swipes the object.

Syntax

object.Swipe direction, [distance], [duration], [startX], [startY]

Arguments

Parameter Description
direction Required. A MoveDirection Value.

The direction of the swipe gesture.

Possible values:

  • moveDown
  • moveLeft
  • moveRight
  • moveUp
distance Optional. A long integer value.

The distance (in pixels) of the swipe gesture.


Default value = 200
duration Optional. A double floating value.

The time period (in seconds) of the swipe gesture.

You can specify partial seconds as a duration time.


Default value = 0.25
startX Optional. A long integer value.
The x-coordinate at which the swipe gesture begins. The coordinate is relative to the upper left corner of the object.
Default value = -9999
startY Optional. A long integer value.
The y-coordinate at which the swipe gesture begins. The coordinate is relative to the upper left corner of the object.
Default value = -9999

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported on Windows Phone.

Example


Back to top

See also: