SlvTable Object

Note: Following the discontinuance of the Silverlight development framework, UFT One no longer supports the Silverlight Add-in out of the box.

If you require the Silverlight Add-in, contact OpenText Support.

Description

A grid control in a Silverlight application.

Operations

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

Note: You can also view a list and descriptions of the SlvTable 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 ActivateCellDouble-clicks the specified cell in a grid.
Method ActivateColumnDouble-clicks the specified column header in a grid.
Method ActivateRowDouble-clicks the specified row header in a grid.
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 ClickClicks the object.
Method DblClickDouble-clicks the object.
Method DragPerforms the 'drag' part of a drag-and-drop operation.
Method DropPerforms the 'drop' part of a drag-and-drop operation.
Method ExtendSelectRowSelects an additional row from the grid.
Method GetCellChildObjectsReturns the collection of child objects contained within the specified cell.
Method GetCellDataRetrieves the contents of the specified cell in a grid.
Method GetCellPropertyRetrieves the value of a grid cell property.
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.
Method GetVisibleTextReturns the text from the specified area.
Method MakeCellVisibleScrolls the specified cell into view if it is not visible in the grid.
Method MakeVisibleScrolls the object into view if it is not visible in the parent window.
Method MouseMoveMoves the mouse pointer to the designated position over the object.
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 SelectCellSelects (clicks) the specified cell in a grid.
Method SelectColumnSelects (clicks) the specified column header in a grid.
Method SelectRowSelects (clicks) the specified row header in a grid.
Method SelectRowsRangeSelects the specified range of rows in the grid.
Method SetCellDataSets the contents of a cell with the specified string.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method ShowContextMenuDisplays the object's context menu.
Common Method ToStringReturns a string that represents the test object.
Method TypeTypes the specified string in the 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

Property ColumnCountThe total number of columns in the grid.
Property DescriptionValueRetrieves the text displayed in the tooltip of the object's associated DescriptionViewer.
Common Property ExistChecks whether the object currently exists in the open application.
Property IsValidIndicates whether the data in the current object is valid.
Common Property ObjectAccesses the native methods and properties of the object.
Property RowCountThe total number of rows in the grid.

Back to top

 

ActivateCell Method

Description

Double-clicks the specified cell in a grid.

Syntax

object.ActivateCell Row, Column

Arguments

ParameterDescription
Row Required. An integer value.
The 0-based index of the row you want to activate.
Column 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 ActivateCell method to activate the cell in the second row of the "Age"
    'column in the SlvTable.
    Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("SLV Toolkit DataGrid").SlvTable("SlvTable").ActivateCell 1,"Age"

Back to top

 

ActivateColumn Method

Description

Double-clicks the specified column header in a grid.

Syntax

object.ActivateColumn Column

Arguments

ParameterDescription
Column 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

Back to top

 

ActivateRow Method

Description

Double-clicks the specified row header in a grid.

Syntax

object.ActivateRow Row

Arguments

ParameterDescription
Row Required. An integer value.
The 0-based index of the row you want to activate.

Return Type

None

Back to top

 

Click Method

Description

Clicks the object.

Syntax

object.Click ([X], [Y], [BUTTON])

Arguments

ParameterDescription
X Optional. An 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. An 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 (-9999) 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. micNoCoordinate indicates the center 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.

Back to top

 

DblClick Method

Description

Double-clicks the object.

Syntax

object.DblClick (X, Y, [BUTTON])

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate of the double-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.
Y Required. An 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 (-9999) 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. micNoCoordinate indicates the center of the object.

BUTTON Optional. A predefined constant or number.
The mouse button used to double-click the object.

Default value = micLeftBtn

Return Type

None.

Back to top

 

Drag Method

Description

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

Syntax

object.Drag ([X], [Y], [BUTTON])

Arguments

ParameterDescription
X Optional. An integer value.
The x-coordinate within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
Default value = -9999
Y Optional. An integer value.
The y-coordinate within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
Default value = -9999
BUTTON Optional. A predefined constant or number.
The mouse button used to drag the object.
Default value = micLeftBtn

Return Type

None.

Back to top

 

Drop Method

Description

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

Syntax

object.Drop ([X], [Y], [BUTTON])

Arguments

ParameterDescription
X Optional. An integer value.
The x-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
Default value = -9999
Y Optional. An integer value.
The y-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
Default value = -9999
BUTTON Optional. A predefined constant or number.
The mouse button that is released to drop the object.
Default value = micLeftBtn

Return Type

None.

Back to top

 

ExtendSelectRow Method

Description

Selects an additional row from the grid.

Syntax

object.ExtendSelectRow Row

Arguments

ParameterDescription
Row Required. An integer value.
The 0-based index of the row you want to add to the selection.

Return Type

None

Example

                    'The following example uses the ExtendSelectRow method to add the first and second rows of the SlvTable
'to the list of selected items in a multiple-selection grid.
Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("SLV Toolkit DataGrid").SlvTable("SlvTable").ExtendSelectRow 0
Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("SLV Toolkit DataGrid").SlvTable("SlvTable").ExtendSelectRow 1

Back to top

 

GetCellChildObjects Method

Description

Returns the collection of child objects contained within the specified cell.

Syntax

object.GetCellChildObjects (Row, Column, [Description])

Arguments

ParameterDescription
Row Required. An integer value.

The 0-based index of the row.

Column Required. A Variant.
The location of the column within the grid. Use the column header name or the column index (0-based).
Description Optional. An Object.

A Properties (collection) object containing the description of the objects contained within the specified item. 

Tip: You can can retrieve a Properties collection using the GetTOProperties method or you can build a Properties collection object using the Description object.  For more information on the Description object, see the Utility section of the UFT One Object Model Reference.

Return Type

An Object.

Back to top

 

GetCellData Method

Description

Retrieves the contents of the specified cell in a grid.

Syntax

object.GetCellData (Row, Column)

Arguments

ParameterDescription
Row Required. An integer value.
The 0-based index of the row containing the cell whose data you want to retrieve.
Column 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 contained in the second row of the "Age"
'column in the SlvTable.
	
MyData = Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("SLV Toolkit DataGrid").SlvTable("SlvTable").GetCellData(1, "Age")
MsgBox(MyData)

Back to top

 

GetCellProperty Method

Description

Retrieves the value of a grid cell property.

Syntax

object.GetCellProperty (Row, Column, Property)

Arguments

ParameterDescription
Row Required. An integer value.
The location of the row within the grid. Use the row index (0-based).
Column Required. A Variant.
The location of the column within the grid. Use the column header name or the column index (0-based).
Property Required. A String value.
The name of the property, specified as a string.
Possible values:
Property Name
Description
x
The X-coordinate of the specified cell relative to the table. 
y
The Y-coordinate of the specified cell relative to the table.
width
The width of the specified cell.
height
The height of the specified cell.
value
The content of the specified cell.
colname
The column header name of the specified cell.

The property name can also be one of System.Windows.Controls.DataGridCell's properties. See https://learn.microsoft.com/en-us/dotnet/api/system.windows.controls.datagridcell

Return Type

A Variant.

Returns the value of the specified property.

If the specified PropertyName is not one of the supported properties, a NOT_IMPLEMENTED error occurs.

Example

                    'The following example uses the GetCellProperty method to retrieve the title of the selected 
'author's book, and then send the title to the server to get detailed information about the book.
'Select an author in the SlvList.

Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("Main").SlvList("authorListBox").Select "Bob" 
'Get the title of the author's first book, which is stored in the first column.
booktitle = Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("Main").SlvTable("booksdataGrid").GetCellProperty(0, 0, "value")
'Enter the book title in the text box.
Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("Main").SlvEdit("searchtextBox").Set booktitle
'Send a request to the server to get detailed information about this book.
Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("Main").SlvButton("Send").Click()

Back to top

 

GetVisibleText Method

Description

Returns the text from the specified area.

Syntax

object.GetVisibleText ([Left], [Top], [Right], [Bottom])

Arguments

ParameterDescription
Left Optional. A long integer value.
The left coordinate of the search area within the object's window.
Default value = -1
Top Optional. A long integer value.
The top coordinate of the search area the object's window.
Default value = -1
Right Optional. A long integer value.
The right coordinate of the search area within the object's window.
Default value = -1
Bottom Optional. A long integer value.
The bottom coordinate of the search area a within the object's window.

Note: If the Left, Top, Right, and Bottom arguments are not specified, the method returns all of the text within the visible part of the specified object.
Default value = -1

Return Type

A String value.

IMPORTANT

  • The text to capture must be visible in the application window when the step runs.
  • The area is defined by pairs of coordinates that designate two diagonally opposite corners of a rectangle.
  • The GetVisibleText method may behave differently in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, or the APIs used in your application. Therefore, when possible, it is highly recommended to use the GetROProperty Method or the Object property to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetVisibleText method.
  • By default, when UFT One captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If UFT One cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).

Back to top

 

MakeCellVisible Method

Description

Scrolls the specified cell into view if it is not visible in the grid.

Syntax

object.MakeCellVisible Row, Column

Arguments

ParameterDescription
Row Required. An integer value.
The 0-based index of the row containing the cell you want to make visible.
Column 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

Back to top

 

MakeVisible Method

Description

Scrolls the object into view if it is not visible in the parent window.

Syntax

object.MakeVisible

Return Type

None.

Back to top

 

MouseMove Method

Description

Moves the mouse pointer to the designated position over the object.

Syntax

object.MouseMove (X, Y)

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate of the mouse pointer, relative to the upper left corner of the object.
Y Required. An integer value.
The y-coordinate of the mouse pointer, relative to the upper left corner of the object.

Return Type

None.

Back to top

 

SelectCell Method

Description

Selects (clicks) the specified cell in a grid.

Syntax

object.SelectCell Row, Column

Arguments

ParameterDescription
Row Required. An integer value.
The 0-based index of the row containing the cell you want to select.
Column 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 select the cell in the second row of the "Age"
'column in the SlvTable.
	
Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("SLV Toolkit DataGrid").SlvTable("SlvTable").SelectCell 1, "Age"

Back to top

 

SelectColumn Method

Description

Selects (clicks) the specified column header in a grid.

Syntax

object.SelectColumn Column

Arguments

ParameterDescription
Column 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 SelectColumn method to select the "Deviation" column in the
' SlvTable.
Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("SLV Toolkit DataGrid").SlvTable("SlvTable").SelectColumn "Deviation"

Back to top

 

SelectRow Method

Description

Selects (clicks) the specified row header in a grid.

Syntax

object.SelectRow Row

Arguments

ParameterDescription
Row Required. An integer value.
The 0-based index of the row you want to select.

Return Type

None

Example

                    ' The following example uses the SelectRow method to select the third row of the SlvTable.
Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("SLV Toolkit DataGrid").SlvTable("SlvTable").SelectRow 2

Back to top

 

SelectRowsRange Method

Description

Selects the specified range of rows in the grid.

Syntax

object.SelectRowsRange StartRow, EndRow

Arguments

ParameterDescription
StartRow Required. An integer value.
The number of the first row to select. Row numbers begin with 0.
EndRow Required. An integer value.
The number of the last row to select. Row numbers begin with 0.

Return Type

None

Back to top

 

SetCellData Method

Description

Sets the contents of a cell with the specified string.

Syntax

object.SetCellData Row, Column, data

Arguments

ParameterDescription
Row Required. An integer value.
The 0-based index of the row containing the cell data you want to set.
Column 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 contents to be entered into the specified cell.

Return Type

None

Example

                    'The following example uses the SetCellData method to modify value of the cell in the second row
'of the "Enabled" column if the value of the cell is set to "False".
	
Browser("SLV Toolkit").Page("SLV Toolkit").SlvWindow("SLV DataGrid").SlvTable("SlvTable").SetCellData 2, "Enabled", False

Back to top

 

ShowContextMenu Method

Description

Displays the object's context menu.

Syntax

object.ShowContextMenu

Return Type

None.

Back to top

 

Type Method

Description

Types the specified string in the object.

Syntax

object.Type (KeyboardInput)

Arguments

ParameterDescription
KeyboardInput Required. A String value.
The text string and/or constants representing non-alphanumeric keys. The following constants are available:
Constant
Action
micCtrlDwn
Presses the Ctrl key.
micCtrlUp
Releases the Ctrl key.
micLCtrlDwn
Presses the left Ctrl key.
micLCtrlUp
Releases the left Ctrl key.
micRCtrlDwn
Presses the right Ctrl key.
micRCtrlUp
Releases the right Ctrl key.
micAltDwn
Presses the Alt key.
micAltUp
Releases the Alt key.
micLAltDwn
Presses the left Alt key.
micLAltUp
Releases the left Alt key.
micRAltDwn
Presses the right Alt key.
micRAltUp
Releases the right Alt key.
micShiftDwn
Presses the Shift key.
micShiftUp
Releases the Shift key.
micLShiftDwn
Presses the left Shift key.
micLShiftUp
Releases the left Shift key.
micRShiftDwn
Presses the right Shift key.
micRShiftUp
Releases the right Shift key.
micIns
Presses the Insert key.
micDel
Presses the Delete key.
micHome
Presses the Home key.
micEnd
Presses the End key.
micPgUp
Presses the Page Up key.
micPgDwn
Presses the Page Down key.
micUp
Presses the Up arrow key.
micDwn
Presses the Down arrow key.
micLeft
Presses the Left arrow key.
micRight
Presses the Right arrow key.
micEsc
Presses the Esc key.
micBack
Presses the Backspace key.
micReturn
Presses the Return key.
micTab
Presses the Tab key.
micBreak
Presses the Break key.
micPause
Presses the Pause key.
micPrintScr
Presses the Print Screen key.
micWinLogoDwn
Presses the Windows Logo key.
micWinLogoUp
Releases the Windows Logo key.
micLWinLogoDwn
Presses the left Windows Logo key.
micLWinLogoUp
Releases the left Windows Logo key.
micRWinLogoDwn
Presses the right Windows Logo key.
micRWinLogoUp
Releases the right Windows Logo key.
micAppKey
Presses the Application key.
micF1
Presses the F1 key.
micF2
Presses the F2 key.
micF3
Presses the F3 key.
micF4
Presses the F4 key.
micF5
Presses the F5 key.
micF6
Presses the F6 key.
micF7
Presses the F7 key.
micF8
Presses the F8 key.
micF9
Presses the F9 key.
micF10
Presses the F10 key.
micF11
Presses the F11 key.
micF12
Presses the F12 key.
micNumLockOn
Turns on the Num Lock.
micCapsLockOn
Turns on the Caps Lock.
micScrollOn
Turns on the Scroll Lock.
micNumLockOff
Turns off the Num Lock.
micCapsLockOff
Turns off the Caps Lock.
micScrollOff
Turns off the Scroll Lock.

Return Type

None.

IMPORTANT

Although the Type method is supported for most objects, if you enter a Type statement for an object in which a user cannot enter text, the method has no visual effect.

Back to top

 

ColumnCount Property

Description

The total number of columns in the grid.

Syntax

object.ColumnCount

Value Type

A long integer value.

Property type

Read-only property

Back to top

 

DescriptionValue Property

Description

Retrieves the text displayed in the tooltip of the object's associated DescriptionViewer.

Syntax

object.DescriptionValue

Value Type

A String value.

Property type

Read-only property

Back to top

 

IsValid Property

Description

Indicates whether the data in the current object is valid.

Syntax

object.IsValid

Value Type

A Boolean value.

Property type

Read-only property

IMPORTANT

UFT One retrieves the value of the IsValid property of the DescriptionViewer control associated with the Silverlight control represented by this test object.

Back to top

 

RowCount Property

Description

The total number of rows in the grid.

Syntax

object.RowCount

Value Type

A long integer value.

Property type

Read-only property

Back to top

See also: