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
ActivateCell | Double-clicks the specified cell in the grid. |
AddRow | Adds a new empty row to the grid. |
CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image using the specified file name. |
Check | Checks whether the actual value of an item matches the expected value. |
CheckProperty | Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout. |
ChildObjects | Returns the collection of child objects contained within the object. |
GetAllROProperties | Returns the collection of properties and current values from the object in the application. |
Click | Clicks the object. |
CollapseRow | Collapses the specified row. |
ColumnCount | Returns the number of columns in the outermost table. |
DeleteRow | Deletes a row from the grid. |
DoubleClick | Clicks on the object twice. |
Drag | Performs the 'drag' part of a drag and drop operation. |
Drop | Performs the 'drop' part of a drag and drop operation. |
ExpandRow | Expands the specified row. |
FireEvent | Triggers an event. |
GetCellData | Retrieves the contents of the specified cell from a table. |
GetROProperty | Returns the current value of the description property from the object in the application. |
GetTOProperties | Returns the collection of properties and values used to identify the object. |
GetTOProperty | Returns the value of the specified description property from the test object description. |
Highlight | Highlights the object in the application. |
GroupRows | Groups grid rows by the specified columns. |
HoverTap | When hover is supported, places the pointer on the object. Otherwise, taps the object. |
LongPress | Presses and holds the object. |
MiddleClick | Middle-clicks the object. |
Output | Retrieves the current value of an item and stores it in a specified location. |
Pan | Perform a pan gesture. |
Pinch | Perform a pinch gesture. |
RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
RightClick | Right-clicks the object. |
RowCount | Returns the number of rows in the outermost table. |
SelectCell | Double-clicks the specified cell in the grid. |
SelectColumn | Selects (clicks) the specified column in the grid. |
SelectRow | Selects (clicks) the specified row in the grid. |
SetCellData | Sets the contents of a cell to the specified text in the grid. |
SetTOProperty | Sets the value of the specified description property in the test object description. |
Sort | Sorts the grid by the specified columns. |
Submit | Submits a form. |
Swipe | Swipes the object. |
ToString | Returns a string that represents the test object. |
WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
Exist | Checks whether the object currently exists in the open application. |
Object | Accesses the native methods and properties of the object. |
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
'The following example uses the ActivateCell method to double-click the cell located 'in the first row of the "ContactTypeID" column of the "UltraWebGrid1" grid. Browser("Flat Grid").Page("Flat Grid").WbfUltraGrid("UltraWebGrid1").ActivateCell "0", "ContactTypeID"
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
'The following example uses the AddRow method to add a new row to the "Products" band 'of the "UltraWebGrid1" grid. Browser("Database Updating").Page("Database Updating").WbfUltraGrid("UltraWebGrid1").AddRow "Products"
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
'The following example uses the Click method to click at coordinates 5, 10 on the "Calendar1" calendar object. Browser("Browser").Page("Page").WbfCalendar("Calendar1").Click 5, 10
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
'The following example uses the CollapseRow method to collapse the fourth child row of 'the first row of the "UltraWebGrid1" grid. Browser("Car Buyer").Page("Car Buyer").WbfUltraGrid("UltraWebGrid1").CollapseRow "0,3"
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
'The following example uses the ColumnCount method to return the number of columns in the first row of 'the "UltraWebGrid1" grid. colCount = Browser("Car Buyer").Page("Car Buyer").WbfUltraGrid("UltraWebGrid1").ColumnCount(1)
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
'The following example uses the DeleteRow method to delete the third child row of the 'first row of the "UltraWebGrid1" grid. Browser("Database Updating").Page("Database Updating").WbfUltraGrid("UltraWebGrid1").DeleteRow "0,2"
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. |
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
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
If you are testing a web or hybrid application on a mobile device, this method is equivalent to performing the DoubleTap gesture.
Example
'The following example double-clicks the "Calendar1" calendar object. Browser("Browser").Page("Page").WbfCalendar("Calendar1").DoubleClick
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
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
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
'The following example uses the ExpandRow method to expand the fourth child row of the 'first row of the "UltraWebGrid1" grid. Browser("Car Buyer").Page("Car Buyer").WbfUltraGrid("UltraWebGrid1").ExpandRow "0,3"
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
'The following example uses the FireEvent method to simulate the mouseover event on a calendar object. Browser("Browser").Page("Page").WbfCalendar("Calendar1").FireEvent "onmouseover"
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
'The following example uses the GetCellData method to return the data in the cell in 'the first row of the "Suppliers" nested band, in the "ContactName" column of the '"UltraWebGrid1" grid. contactName = Browser("Database Updating").Page("Database Updating").WbfUltraGrid("UltraWebGrid1 ").GetCellData "0","Suppliers,ContactName"
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 UFT One User Guide.
Example
'The following example uses the GroupRows method to group the rows of the '"UltraWebGrid1" grid by the "LastName" column. Browser("Flat Grid").Page("Flat Grid").WbfUltraGrid("UltraWebGrid1").GroupRows "LastName"
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 Digital Lab, 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
'When performed in an environment that supports hovering, such as a desktop browser, 'the following example hovers over the checkbox, perhaps displaying a tooltip. 'When performed in an environment that does not support hovering, such as a mobile 'browser, the example taps the checkbox instead, perhaps selecting it. Browser("Booking Site").Page("Find Flights").WbfCalendar("roundtrip").HoverTap
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 Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
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
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 Digital Lab 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
'The following example performs a Pan gesture on a WbfCalendar object. Device("Device").App("Mobile Web_2").MobileWebView("Web View").WbfCalendar("Calendar1").Pan 564, 507
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 Digital Lab 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
'The following example performs a Pinch gesture on a WbfCalendar object, where the zoom is multiplied by 2.5. Device("Device").App("Mobile Web_2").MobileWebView("Web View").WbfCalendar("Calendar1").Pinch 2.5
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
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
'The following example uses the RowCount method to return the number of rows in the "UltraWebGrid1" grid. RowCount = Browser("Car Buyer").Page("Car Buyer").WbfUltraGrid("UltraWebGrid1").RowCount()
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
'The following example uses the SelectCell method to click the cell located in the 'fifth row of the "Single" column of the "UltraWebGrid1" grid. Browser("Flat Grid").Page("Flat Grid").WbfUltraGrid("UltraWebGrid1").SelectCell "4", "Single"
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). Default value = False |
Return Type
None.
Example
'The following example uses the SelectColumn method to select the "LastName" column of 'the "UltraWebGrid1" grid. Browser("Flat Grid").Page("Flat Grid").WbfUltraGrid("UltraWebGrid1").SelectColumn "LastName"
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
'The following example uses the SelectRow method to select the fifth row in addition 'to any other currently selected rows in the "UltraWebGrid1" grid. Browser("Flat Grid").Page("Flat Grid").WbfUltraGrid("UltraWebGrid1").SelectRow "4", True
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. |
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
'The following example uses the SetCellData method to enter the value "David" in the 'cell located in the first row of the "Suppliers" nested band, in the "ContactName" 'column of the "UltraWebGrid1" grid. Browser("Database Updating").Page("Database Updating").WbfUltraGrid("UltraWebGrid1 ").SetCellData "0", "Suppliers,ContactName", "David"
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
'The following example uses the Sort method to sort the grid by the "LastName" column 'of the "UltraWebGrid1" grid, in descending order, without multiple column sorting. Browser("Flat Grid").Page("Flat Grid").WbfUltraGrid("UltraWebGrid1").Sort "LastName", True, False
Submit Method
Description
Submits a form.
Syntax
object.Submit
Return Type
None.
Example
'The following example uses the Submit method to submit a form in which a calendar is located. Browser("Browser").Page("Page").WbfCalendar("Calendar1").Submit
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:
|
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 Digital Lab 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
'The following example performs a Swipe gesture on a WbfUltraGrid object. Device("Device").App("Mobile Web_2").MobileWebView("Web View").WbfUltraGrid("UltraWebGrid1").Swipe moveDown,200,1,75,75
See also: