HTMLTableFunctions

HTMLTableFunctions::ActivateCell
RJ SE

Attempts to perform a double click on a Table cell.

Clicks on a particular row/column of the table. The default location is Row=1, Col=1 unless either parameter is specified otherwise.

Fields: [ ]=Optional with Default Value

[ Row = 1 ]

The 1-based cell row in the row/col specification.

[ Col = 1 ]

The 1-based cell column in the row/col specification.

Examples:

T, WebBrowser, WebTable, ActivateCell
Click the cell at row,col cell 1,1.

T, WebBrowser, WebTable, ActivateCell, 3, 4
Click the cell at row,col cell 3,4.

[How To Read This Reference]

HTMLTableFunctions::AssignCellContainsTextRow
RJ SE

Assigns a user-defined variable a row # based on partial matching cell values.

The cell value from the specified column in the found row is also assigned to a variable derived from the user-defined variable name.

The cell value comparisons are not case-senstive, and provided values can be substrings of the actual cell value in the table.

Fields: [ ]=Optional with Default Value

Var

The variable which gets assigned the row found.

The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be the user-defined variable +".Value".

Col

The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.
The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.

ColN

A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.
The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.

ValueN

A Value to search for in the 'COLN' column.

These values can be partial substrings and are not case-sensitive.

Examples:

T, WebBrowser, WebTable, AssignCellContainsTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"
Assigns the variable "Variable" the first row # satisfying the matching colN/valueN values.

Also assigns variable "Variable.Value" the cell value found in the "Date" column at the matching row.

[How To Read This Reference]

HTMLTableFunctions::AssignCellTextRow
RJ SE

Assigns a user-defined variable a row # based on matching cell values.

The cell value from the specified column in the found row is also assigned to a variable derived from the user-defined variable name.

Fields: [ ]=Optional with Default Value

Var

The variable which gets assigned the row found.

The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be this user-defined variable +".Value".

Col

The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

ColN

A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

ValueN

A Value to search for in the 'COLN' column

These values are case-sensitive and must consititute an exact match.

Examples:

T, WebBrowser, WebTable, AssignCellTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"
Assigns the variable "Variable" the first row # satisfying the matching colN/valueN values.

Also assigns variable "Variable.Value" the cell value found in the "Date" column at the matching row.

[How To Read This Reference]

HTMLTableFunctions::AssignVariableCellText
RJ SE

Attempts to extract a particular cell value and assign it to the provided variable name.

Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Fields: [ ]=Optional with Default Value

VariableName

The name of the variable to receive the property value.

The name of the variable to receive the property value. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

[ Row = 1 ]

The 1-based cell row # in the row/col specification.

RJ: Does not yet support using a unique row value in column 1 as a row identifier.

[ Col = 1 ]

The 1-based cell column # in the row/col specification.

RJ: Does not yet support using a unique col header value as a column identifier.

Examples:

T, WebBrowser, WebTable, AssignVariableCellText, AVariableName
Assign the value of cell 1,1 to DDVariable ^AVariableName.

T, WebBrowser, WebTable, AssignVariableCellText, "AVariableName", 1 , 1
Assign the value of cell 1,1 to DDVariable ^AVariableName.

T, WebBrowser, WebTable, AssignVariableCellText, "^AVariableName", ^row=4, ^col="5"
Assign the value of cell 4,5 to DDVariable ^AVariableName.

C, SetVariableValues, ^AVariableName="NextVariableName"
T, WebBrowser, WebTable, AssignVariableCellText, ^AVariableName, ^row="5", ^col=2
Assign the value of cell 5,2 to DDVariable ^NextVariableName.

[How To Read This Reference]

HTMLTableFunctions::CaptureFuzzyRangeToFile
RJ SE

Saves a range of values to the specified file.

"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.

Fields: [ ]=Optional with Default Value

FileName

The name of the file to receive the data.

The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
Any specified full or relative path must already exist.

[ Row = 1 ]

The 1-based cell row # in the row/col specification or a unique row value in column 1.

The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

[ Col = 1 ]

The 1-based cell column # in the row/col specification or column header text.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

[ Rows = ]

The number of rows to capture.

If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
If the parameter is not provided, all subsequent rows from the specified starting row are captured.

[ Columns = ]

The number of columns to capture.

If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
If the parameter is not provided, all subsequent columns from the specified starting column are captured.

[ FileEncoding = ]

Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

[ FilterMode = ]

(FUTURE) A file filter to use when processing the text values.

[ FilterOptions = ]

(FUTURE) Filter options to use with the file filter.

Examples:

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt
Saves the entire table into <project>\Datapool\Test\AFileName.txt

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt, 1 , 1
Saves the entire table into <project>\Datapool\Test\AFileName.txt

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt, 4, "field5", 2, 5
Saves a 2 rows by 5 columns range of cells starting at cell 4, Field5.

The starting column is determined by fuzzy matching the text "field5" to the field headers in the WebTable. The captured table values are saved into <project>\Datapool\Test\AFileName.txt

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt, "datum", 5, , 2
Saves a range of all remaining rows by 2 columns wide starting at cell "ADatum", "Field5".

The starting row is determined by seeking the first cell in column 1 in the WebTable that contains substring "datum". The "5" also shows up as a substring match to the column header "Field5". So be cautious, here. No ROWS parameter was provided. Thus, all subsequest rows from the 2 columns are captured. The values are saved into <project>\Datapool\Test\AFileName.txt

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt, , , , , "UTF-8"
Saves the entire table into <project>\Datapool\Test\AFileName.txt

Saves the entire table into <project>\Datapool\Test\AFileName.txt
Writing file with "UTF-8" encoding.

[How To Read This Reference]

HTMLTableFunctions::CaptureRangeToFile
RJ SE

Saves a range of values to the specified file.

Fields: [ ]=Optional with Default Value

FileName

The name of the file to receive the data.

The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
Any specified full or relative path must already exist.

[ Row = 1 ]

The 1-based cell row # in the row/col specification or a unique row value in column 1.

The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

[ Col = 1 ]

The 1-based cell column # in the row/col specification or column header text.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

[ Rows = ]

The number of rows to capture.

If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
If the parameter is not provided, all subsequent rows from the specified starting row are captured.

[ Columns = ]

The number of columns to capture.

If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
If the parameter is not provided, all subsequent columns from the specified starting column are captured.

[ FileEncoding = ]

Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

[ FilterMode = ]

(FUTURE) A file filter to use when processing the text values.

[ FilterOptions = ]

(FUTURE) Filter options to use with the file filter.

Examples:

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt
Saves the entire table into >project>\Datapool\Test\AFileName.txt

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt, 1 , 1
Saves the entire table into <project>\Datapool\Test\AFileName.txt

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt, 4, "Field5", 2, 5
Saves a 2 rows by 5 columns range of cells starting at cell 4, Field5.

The starting column is determined by matching the text "Field5" to the field headers in the WebTable. The values are saved into <project>\Datapool\Test\AFileName.txt

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt, "ADatum", 5, , 2
Saves a range of all remaining rows by 2 columns wide starting at cell "ADatum", 5.

The starting row is determined by matching the text "ADatum" to the first cell in column 1 in the WebTable that contains "ADatum". Since no ROWS parameter was provided, all subsequest rows from the 2 columns are captured. The values are saved into <project>\Datapool\Test\AFileName.txt

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt, , , , , "UTF-8"
Saves the entire table into >project>\Datapool\Test\AFileName.txt

Saves the entire table into >project>\Datapool\Test\AFileName.txt
Writing file with "UTF-8" encoding.

[How To Read This Reference]

HTMLTableFunctions::Click (deprecated for: Generic CLICK)
WR

Attempts to perform a standard Click on an HTMLTable on a webpage.

Attempts to perform a standard Click on an HTMLTable on a webpage. We can optionally click on a particular area of the table rather than a generic click (Coords=1,1).

The click area lookup is done with the component name AND an additional app map reference provided in Field #5.

Typical Data Table records:

(1) t BrowserWin ATable Click
(2) t BrowserWin ATable Click AMappedRegion

#1 above should merely click in the top-left corner of the table.

#2 above will contain a ATable entry in the BrowserWin section with normal recognition information for it. ATable will also have it's own section in the Application Map in which there will be entries defining specific indexed or named regions for the table.

Examples:

[BrowserWin]
BrowserWin=WindowTag=WEBBrowser
ATable=Type=HTMLFrame;HTMLID=top;Type=HTMLTable;Index=1
...

[ATable]
AMappedRegion=Coords=10,10
ANamedRegion=Coords=10,10,25,25
AnIndexedRegion=Col=1;Row=1

Fields: [ ]=Optional with Default Value

[ AppMapSubkey = ]

Name of the AppMap subkey to lookup and use for the click.

Name of the AppMap subkey to lookup and use for the click. The AppMap can contain the item in any of the following formats:

[ATable]
AMappedRegion=Coords=10,10
ANamedRegion=Coords=10,10,25,25
AnIndexedRegion=Col=1;Row=1

Any valid content used with the HTMLTable Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Examples:

T, WebBrowser, WebTable, CLICK, Centert
A single-click is performed on the WebTable at the location referenced in the App Map for Centert.

Field [5]: TQ String. Optional reference identified in the Application Map identifying where to click.

[WebTable]
Center=Coords=10,10
Field10=Col=10;Row=1

If no reference is given then Coords 1,1 will be clicked.

[How To Read This Reference]

HTMLTableFunctions::ClickCell
RC RJ WR SE

Click on a cell specified by row and column.

Click on a cell specified by row and column parameters.

Note, for the RobotJ version, (and maybe other engines as well), the row and column values are true to the TR and TD elements of the web page, so if a TR or TD has no text in it, then it may seem confusing. In other words, a table may only seem to have lets say 5 columns, but there may actually be more based on the contents of the cells.

Fields: [ ]=Optional with Default Value

Row

The row of the cell to click.

The cell is fully defined by the intersection of the row and column values.

Col

The column of the cell to click.

The cell is fully defined by the intersection of the row and column values.

Examples:

T, WebBrowser, WebTable, ClickCell, 1, 3
A single-click is performed on the WebTable at row 1, column 3.

[How To Read This Reference]

HTMLTableFunctions::CompareStoredData (deprecated for: Generic CompareStoredData)
WR

Performs a HTMLTableVP CompareData on an HTMLTable object.

Performs a HTMLTableVP CompareProperties on an HTMLTable object.

THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY RUNNING SCRIPT.

Modified VP parameter information can be added to the standard VP=VPName by including the VPName reference in the application map in a section defined for the HTMLTable. If this is done, the value retrieved from the application map will be appended to VP=VPName. The required semicolon for this append will be provided by this routine.

Example 1: Perform a standard HTMLTable CompareProperties. To perform a basic CompareProperties the name "StoredVP" will not exist in the app map:

The Step File call:

BrowserWindow AnHTMLTable CompareStoredProperties StoredVP

This will produce a CompareProperties VP with "VP=StoredVP;Wait=2,10".

The StoredVP baseline MUST already exist as an asset of the currently running script.

Example 2: Perform a HTMLTable CompareProperties providing addition parameter information (such as ExpectedResult=FAIL). To do this the HTMLTable object must have its own section in the app map and an item with the same name as the StoredVP. The value of that item will be appended to the standard VP argument with a semicolon.

Part of App Map:

[BrowserWindow]
BrowserWindow=WindowTag=WEBBrowser
AnHTMLTable=<snipped for brevity>;\;Type=HTMLTable;HTMLID=TableID
...
[AnHTMLTable]
StoredVP=ExpectedResult=FAIL;Wait=3,30

The Step File call:

BrowserWindow AnHTMLTable CompareStoredProperties StoredVP

This will produce a CompareProperties VP with all the parameters appended like this: "VP=StoredVP;ExpectedResult=FAIL;Wait=3,30". NOTE:When stored parameters are found in the app map then the default Wait= parameter used in the standard compare is no longer provided. If you still need a Wait= parameter, then it must be included in the stored parameters.

The StoredVP baseline MUST already exist as an asset of the currently running script.

Fields: [ ]=Optional with Default Value

VPAsset

Name of the pre-existing VP asset stored in the currently running script.

Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call.

Examples:

T, WebBrowser, WebPage, COMPARESTOREDDATA, "AStoredVP"
This action compares stored data on the WebPage object against "AStoredVP".

Field 5 : TQ String. The name of a stored CompareData VP which must exist as an asset of the currently running script. You can also specify additional VP parameters by including a reference in the application map.

[WebPage]
AStoredVP=ExpectedResult=FAIL;Wait=3,30

[How To Read This Reference]

HTMLTableFunctions::CompareStoredProperties (deprecated for: Generic CompareStoredProperties)
WR

Performs a HTMLTableVP CompareProperties on an HTMLTable object.

THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY RUNNING SCRIPT.

Example 1: Perform a standard HTMLTable CompareProperties. To perform a basic CompareProperties the name "StoredVP" will not exist in the app map:

The Step File call:

BrowserWindow AnHTMLTable CompareStoredProperties StoredVP

This will produce a CompareProperties VP with "VP=StoredVP;Wait=2,10".

The StoredVP baseline MUST already exist as an asset of the currently running script.

Part of App Map:

[BrowserWindow]
BrowserWindow=WindowTag=WEBBrowser
AnHTMLTable=<snipped for brevity>;\;Type=HTMLTable;HTMLID=TableID
...
[AnHTMLTable]
StoredVP=ExpectedResult=FAIL;Wait=3,30

The Step File call:

BrowserWindow AnHTMLTable CompareStoredProperties StoredVP

The StoredVP baseline MUST already exist as an asset of the currently running script.

Fields: [ ]=Optional with Default Value

VPAsset

Name of the pre-existing VP asset stored in the currently running script.

Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call.

Examples:

T, WebBrowser, WebPage, COMPARESTOREDPROPERTIES, "AStoredVP"
This action performs a CompareProperties on the WebPage object against "AStoredVP".

Field 5 : TQ String. The name of a stored CompareProperties VP which must exist as an asset of the currently running script. You can also specify additional VP parameters by including a reference in the application map. [WebPage]
AStoredVP=ExpectedResult=FAIL;Wait=3,30

[How To Read This Reference]

HTMLTableFunctions::DoubleClickCell
RJ SE

Attempts to perform a double click on a cell in a Table.

Clicks on a particular row/column of the table. The default location is Row=1, Col=1 unless either parameter is specified otherwise.

Fields: [ ]=Optional with Default Value

[ Row = 1 ]

The 1-based cell row in the row/col specification.

[ Col = 1 ]

The 1-based cell column in the row/col specification.

Examples:

T, WebBrowser, WebTable, DoubleClickCell
Click the cell at row,col cell 1,1.

T, WebBrowser, WebTable, DoubleClickCell, 3, 4
Click the cell at row,col cell 3,4.

[How To Read This Reference]

HTMLTableFunctions::RightClickCell
RJ SE

Attempts to perform a right click on a cell in a Table.

Right clicks on a particular row/column of the table. The default location is Row=1, Col=1 unless either parameter is specified otherwise.

RJ: CFHTMLTable gets this support from subclassing CFTable.

Fields: [ ]=Optional with Default Value

[ Row = 1 ]

The 1-based cell row in the row/col specification.

[ Col = 1 ]

The 1-based cell column in the row/col specification.

Examples:

T, WebBrowser, WebTable, RightClickCell
Right click the cell at row,col cell 1,1.

T, WebBrowser, WebTable, RightClickCell, 3, 4
Right click the cell at row,col cell 3,4.

[How To Read This Reference]

HTMLTableFunctions::SelectCell
RJ SE

Same as ClickCell.

Clicks on a particular row/column of the table. The default location is Row=1, Col=1 unless either parameter is specified otherwise.

Fields: [ ]=Optional with Default Value

[ Row = 1 ]

The 1-based cell row in the row/col specification.

[ Col = 1 ]

The 1-based cell column in the row/col specification.

Examples:

T, WebBrowser, WebTable, SelectCell
Click the cell at row,col cell 1,1.

T, WebBrowser, WebTable, SelectCell, 3, 4
Click the cell at row,col cell 3,4.

[How To Read This Reference]

HTMLTableFunctions::SelectCellContainsTextFind
RJ SE

Attempts to select a particular cell by finding the row based on cell values.

This is the same as SelectFuzzyCellTextFind.
The row # for the cell is also assigned to a user-defined variable. The parameter values are not case-sensitive, and can be substrings of the actual table values.

Fields: [ ]=Optional with Default Value

Var

The variable which gets assigned the row found.

The variable which gets assigned the row found. If not found then it will get a zero length string

Col

The 1-based cell column # or header value, identifying the column for the select.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.
These comparisons are not case-sensitive and can be substrings of the actual table text.

ColN

A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.
These comparisons are not case-sensitive and can be substrings of the actual table text.

ValueN

A Value to search for in the 'COLN' column

The values are not case-sensitive and can be substrings of the actual table text.

Examples:

T, WebBrowser, WebTable, SelectCellContainsTextFind, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"
Selects the cell in the first row matching the colN/valueN values.

Selects the "Date" cell in the row matching the colN/valueN values: "Time"/"09:58 AM", "Change"/"Change #2", "Revision"/"2". The variable 'Variable' will be assigned the matching row number.
These comparisons are not case-sensitive and can be substrings of the actual table text.

[How To Read This Reference]

HTMLTableFunctions::SelectCellText
RJ SE

Attempts to select a particular cell.

Fields: [ ]=Optional with Default Value

[ Row = 1 ]

The 1-based cell row # in the row/col specification or a unique row value in column 1.

The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

[ Col = 1 ]

The 1-based cell column # in the row/col specification or column header text.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Examples:

T, WebBrowser, WebTable, SelectCellText
Selects cell 1,1 in WebTable.

Default row and column indices substituted for missing parameters.

T, WebBrowser, WebTable, SelectCellText, 1 , 1
Selects cell 1,1 in WebTable.

T, WebBrowser, WebTable, SelectCellText, 4, "Field5"
Selects cell 4, Field5 in WebTable.

The column is determined by matching the text "Field5" to the field headers in the WebTable.

T, WebBrowser, WebTable, SelectCellText, "ADatum", 5
Selects cell ADatum,5 in WebTable.

The row is determined by matching the text "ADatum" to the first cell in column 1 in the WebTable that contains "ADatum".

[How To Read This Reference]

HTMLTableFunctions::SelectCellTextFind
RJ SE

Attempts to select a particular cell by finding the row based on cell values.

The row # for the cell is also assigned to a user-defined variable.

Fields: [ ]=Optional with Default Value

Var

The variable which gets assigned the row found.

The variable which gets assigned the row found. If not found then it will get a zero length string

Col

The 1-based cell column # or header value, identifying the column for the select.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

ColN

A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

ValueN

A Value to search for in the 'COLN' column

Examples:

T, WebBrowser, WebTable, SelectCellTextFind, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"
Selects the cell in the first row matching the colN/valueN values.

Selects the "Date" cell in the row matching the colN/valueN values: "Time"/"09:58 AM", "Change"/"Change #2", "Revision"/"2". The variable 'Variable' will be assigned the matching row number.

[How To Read This Reference]

HTMLTableFunctions::SelectCellTextSpecial
RJ

Holds down either key Control or Shift while making a cell selection with emulating either a Left or Right mouse click.

Special cell selection which can be used to select multiple rows.

Fields: [ ]=Optional with Default Value

SpecialKey

The special key command used in the row selection. For now, ownly "Control" and "Shift" are supported.

MouseClick

The type of mouse click needed. For now, ownly "Left" and "Right" are supported.

Row

The 1-based cell row in the row/col specification.

Col

The 1-based cell column in the row/col specification.

Examples:

T, WebBrowser, WebTable, SelectCellTextSpecial, Control, Left, 2, 3
Performs a LeftClick on cell 2,3 while holding down the CONTROL key.

T, WebBrowser, WebTable, SelectCellTextSpecial, Shift, Left, 2, 3
Performs a LeftClick on cell 2,3 while holding down the SHIFT key.

[How To Read This Reference]

HTMLTableFunctions::SelectFuzzyCellText
RJ SE

Attempts to select a particular cell.

Fields: [ ]=Optional with Default Value

[ Row = 1 ]

The 1-based cell row # in the row/col specification or a unique row value in column 1.

The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

[ Col = 1 ]

The 1-based cell column # in the row/col specification or column header text.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Examples:

T, WebBrowser, WebTable, SelectFuzzyCellText
Selects cell 1,1 in WebTable.

Default row and column indices substituted for missing parameters.

T, WebBrowser, WebTable, SelectFuzzyCellText, 1 , 1
Selects cell 1,1 in WebTable.

T, WebBrowser, WebTable, SelectFuzzyCellText, 4, "field5"
Selects cell 4, "Field5" in WebTable.

The column is determined by case-insensitive comparing the text "field5" to the field headers in the WebTable.

T, WebBrowser, WebTable, SelectFuzzyCellText, "datum", 5
Selects cell ADatum,Field5 in WebTable.

The row is determined by seeking the first cell in column 1 in the WebTable that contains substring "datum". The "5" also shows up as a substring match to the column header "Field5". So be cautious, here.

[How To Read This Reference]

HTMLTableFunctions::SelectFuzzyCellTextFind
RJ SE

Attempts to select a particular cell by finding the row based on fuzzy cell values.

This is the same as SelectCellContainsTextFind.
"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified column/cell text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.

Fields: [ ]=Optional with Default Value

Var

The variable which gets assigned the row found.

The variable which gets assigned the row found. If not found then it will get a zero length string

Col

The 1-based cell column # in the row/col specification or fuzzy column header text.

The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

ColN

A 1-based cell column # in the row/col specification or fuzzy column header text.

The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

ValueN

A Value to search for in a cell under the 'ColN' column

A Value to search for in a cell under the 'ColN' column

Examples:

T, WebBrowser, WebTable, SelectFuzzyCellTextFind, Variable, "Da","Ti", "09:58 AM", "Cha","Change #2","Rev", "2"
Selects the cell in the row matching the colN/valueN values.

Selects the "Da" cell in the row fuzzy-matching the colN/valueN values: "Ti"/"09:58 AM", "Cha"/"Change #2", "Rev"/"2". The variable 'Variable' will be assigned the matching row number.

[How To Read This Reference]

HTMLTableFunctions::VerifyCellEditable
RJ SE

Verifies whether the specified cell is editable.

RJ: Invokes the "editCellAt" method on a specific cell. That method returns a boolean which is used for the verification.

Fields: [ ]=Optional with Default Value

Row

The 1-based cell row in the row/col specification.

Col

The 1-based cell column in the row/col specification.

ExpectedValue

The case-insensitive value we expect for the editable value ("true" or"false").

Examples:

T, WebBrowser, WebTable, VerifyCellEditable, "2", "3", "true"
Verifies that the cell in 2,3 is editable.

[How To Read This Reference]

HTMLTableFunctions::VerifyCellText
RJ SE

Attempts to verify a particular cell value.

Fields: [ ]=Optional with Default Value

BenchValue

The case-sensitive expected value for the specified cell.

[ Row = 1 ]

The 1-based cell row # in the row/col specification.

RJ: Does not yet support using a row value in Column 1 as a row identifier.

[ Col = 1 ]

The 1-based cell column # in the row/col specification.

RJ: Does not yet support using a column header value as a column identifier.

Examples:

T, WebBrowser, WebTable, VerifyCellText, FirstCellValue
Compares the value of cell 1,1 to bench text "FirstCellValue".

Default row and column indices substituted for missing parameters.

T, WebBrowser, WebTable, VerifyCellText, "FirstCellValue", 1 , 1
Compares the value of cell 1,1 to bench text "FirstCellValue".

T, WebBrowser, WebTable, VerifyCellText, "BenchValue", ^row=4, ^col="5"
Compares the value of cell 4,5 to bench text "BenchValue".

T, WebBrowser, WebTable, VerifyCellText, "BenchData", ^row="5", ^col=2
Compares the value of cell 5,2 to bench text "BenchData".

[How To Read This Reference]

HTMLTableFunctions::VerifyCellTextContains
RJ SE

Attempts to verify a particular cell value.

The value comparison is NOT case-sensitive and can be a substring.

Fields: [ ]=Optional with Default Value

BenchValue

The expected value for the specified cell.

The value can be a substring of the full expected value and is NOT case-sensitive.

[ Row = 1 ]

The 1-based cell row # in the row/col specification.

RJ: Does not yet support using a unique row value in Column 1 as a row specifier.

[ Col = 1 ]

The 1-based cell column # in the row/col specification.

RJ: Does not yet support using a unique column header value as a column specifier.

Examples:

T, WebBrowser, WebTable, VerifyCellTextContains, FirstCellValue
Matches the "FirstCellValue" value of cell 1,1 to bench text "FirstCellValue".

In this case, they happen to be an exact match. Default row and column indices are used for missing parameters.

T, WebBrowser, WebTable, VerifyCellTextContains, "firstcell", 1 , 1
Matches the "FirstCellValue" value of cell 1,1 to bench text "firstcell".

"firstcell" is a valid substring match since it is not case-sensitive.

T, WebBrowser, WebTable, VerifyCellTextContains, "bench", ^row=4, ^col="5"
Matches the "BenchValue" value of cell 4,5 to bench text "bench".

"bench" is a valid substring match since it is not case-sensitive.

[How To Read This Reference]

HTMLTableFunctions::VerifyCellTextFind
RJ SE

Attempts to verify a particular cell by finding the row based on cell values.

Fields: [ ]=Optional with Default Value

BenchValue

The case-sensitive expected value for the specified cell.

Var

The variable which gets assigned the row found.

The variable which gets assigned the row found. If not found then it will get a zero length string

Col

The 1-based cell column # in the row/col specification or column header text.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

ColN

A 1-based cell column # in the row/col specification or column header text.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

ValueN

A Value to search for in a cell under the 'ColN' column

A Value to search for in a cell under the 'ColN' column

Examples:

T, WebBrowser, WebTable, VerifyCellTextFind, "10/09/2003", Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"
Verifies the cell in the row matching the colN/valueN values.

Verifies the "Date" cell in the row matching the colN/valueN values: "Time"/"09:58 AM", "Change"/"Change #2", "Revision"/"2" is equal "10/09/2003". The variable 'Variable' will be assigned the matching row number.

[How To Read This Reference]

HTMLTableFunctions::VerifyCellValue
RJ WR SE

Verify the value of a specific Cell.

Attemps to verify the contents of a table cell on a webpage should the command not contain what cell to verify it will default to 1,1

Fields: [ ]=Optional with Default Value

ExpectedValue

The Expected Value of the cell.

The Expected Value of the cell, this will be used to compare with the actual value of the cell and logged as a pass or fail. This value is case sensitive and should acurately reflect the text string of the cell being tested.

[ Cell = ]

This is the optional cell location to be tested

This is the optional cell location to be tested, it will be assummed if value is not present that the command is referencing cell 1,1

Examples:

T, WebBrowser, WebTable, VerifyCellValue, ExpectedValue
The value is verified at row 1, column 1.

T, WebBrowser, WebTable, VerifyCellValue, ExpectedValue, "2,2"
The value is verified at row 2, column 2.

[How To Read This Reference]

HTMLTableFunctions::VerifyColumnLabel
RJ SE

Attempts to verify a particular column's label when given a column number.

Verifies a column label when given the column number. It currently does NOT work with columns with multi-line names.

Fields: [ ]=Optional with Default Value

ColLabel

The case-insensitive expected value for the specified column label.

ColNumber

The 1-based column number of the label that needs verified.

Examples:

T, WebBrowser, WebTable, VerifyColumnLabel, "Foo", "4"
Verifies that the 4th column in the table has the label "Foo".

T, WebBrowser, WebTable, VerifyColumnLabel, "Foo SecondFoo", "4"
Verifies that the 4th column in the table has the label "Foo SecondFoo"

This will verify correctly if the column label is all on one line, but if "Foo" is on one line, and "SecondFoo" is on a separate line, this verification will not work.

[How To Read This Reference]

HTMLTableFunctions::VerifyFuzzyCellText
RJ SE

Attempts to verify a particular cell value.

Fields: [ ]=Optional with Default Value

BenchValue

The case-sensitive expected value for the specified cell.

[ Row = 1 ]

The 1-based cell row # in the row/col specification or a unique row value in column 1.

The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

[ Col = 1 ]

The 1-based cell column # in the row/col specification or column header text.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Examples:

T, WebBrowser, WebTable, VerifyFuzzyCellText, FirstCellValue
Compares the value of cell 1,1 in WebTable to bench Text "FirstCellValue".

Default row and column indices substituted for missing parameters.

T, WebBrowser, WebTable, VerifyFuzzyCellText, "FirstCellValue", 1 , 1
Compares the value of cell 1,1 in WebTable to bench text "FirstCellValue".

T, WebBrowser, WebTable, VerifyFuzzyCellText, ABenchValue, 4, "field5"
Compares the value of cell 4, "Field5" in WebTable to bench text "ABenchValue".

The column is determined by case-insensitive comparing the text "field5" to the field headers in the WebTable.

T, WebBrowser, WebTable, VerifyFuzzyCellText, ^ABenchValue, "datum", 5
Compares the value of cell ADatum,Field5 in WebTable to bench text in variable ^ABenchValue.

The row is determined by seeking the first cell in column 1 in the WebTable that contains substring "datum". The "5" also shows up as a substring match to the column header "Field5". So be cautious, here.

[How To Read This Reference]

HTMLTableFunctions::VerifyFuzzyCellTextContains
RJ SE

Attempts to verify a particular cell value.

Fields: [ ]=Optional with Default Value

BenchValue

The expected value for the specified cell.

The value can be a substring of the full expected value and is NOT case-sensitive.

[ Row = 1 ]

The 1-based cell row # in the row/col specification or a unique row value in column 1.

The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

[ Col = 1 ]

The 1-based cell column # in the row/col specification or column header text.

The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Examples:

T, WebBrowser, WebTable, VerifyFuzzyCellTextContains, FirstCellValue
Matches the "FirstCellValue" value of cell 1,1 in WebTable to bench text "FirstCellValue".

Default row and column indices substituted for missing parameters.
This also happens to be an exact text match.

T, WebBrowser, WebTable, VerifyFuzzyCellTextContains, "firstcell", 1 , 1
Matches the "FirstCellValue" value of cell 1,1 in WebTable to bench text "firstcell".

"firstcell" is a matching substring of the retrieved cell value.

T, WebBrowser, WebTable, VerifyFuzzyCellTextContains, bench, 4, "field5"
Matches the "ABenchValue" value of cell 4, "Field5" in WebTable to bench text "bench".

The column is determined by case-insensitive comparing the text "field5" to the field headers in the WebTable. "bench" is a matching substring of the retrieved cell value.

T, WebBrowser, WebTable, VerifyFuzzyCellText, bench, "datum", 5
Matches the "ABenchValue" value of cell ADatum,Field5 in WebTable to bench text "bench".

The row is determined by seeking the first cell in column 1 in the WebTable that contains substring "datum". The "5" also shows up as a substring match to the column header "Field5". So be cautious, here.
"bench" is a matching substring of the retrieved cell value.

[How To Read This Reference]

HTMLTableFunctions::VerifyFuzzyCellTextFind
RJ SE

Attempts to verify a particular cell by finding the row based on fuzzy cell values.

"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified column/cell text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.

Fields: [ ]=Optional with Default Value

BenchValue

The case-sensitive expected value for the specified cell.

Var

The variable which gets assigned the row found.

The variable which gets assigned the row found. If not found then it will get a zero length string

Col

The 1-based cell column # in the row/col specification or fuzzy column header text.

The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

ColN

A 1-based cell column # in the row/col specification or fuzzy column header text.

The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

ValueN

A Value to search for in a cell under the 'ColN' column

A Value to search for in a cell under the 'ColN' column

Examples:

T, WebBrowser, WebTable, VerifyFuzzyCellTextFind, "10/09/2003", Variable, "Da","Ti", "09:58 AM", "Cha","Change #2","Rev", "2"
Verifies the cell in the row matching the colN/valueN values.

Verifies the "Da" cell in the row fuzzy-matching the colN/valueN values: "Ti"/"09:58 AM", "Cha"/"Change #2", "Rev"/"2" is equal "10/09/2003". The variable 'Variable' will be assigned the matching row number.

[How To Read This Reference]

HTMLTableFunctions

HTMLTableFunctions::ActivateCell RJ SE

HTMLTableFunctions::AssignCellContainsTextRow RJ SE

HTMLTableFunctions::AssignCellTextRow RJ SE

HTMLTableFunctions::AssignVariableCellText RJ SE

HTMLTableFunctions::CaptureFuzzyRangeToFile RJ SE

HTMLTableFunctions::CaptureRangeToFile RJ SE

HTMLTableFunctions::Click (deprecated for: Generic CLICK) WR

HTMLTableFunctions::ClickCell RC RJ WR SE

HTMLTableFunctions::CompareStoredData (deprecated for: Generic CompareStoredData) WR

HTMLTableFunctions::CompareStoredProperties (deprecated for: Generic CompareStoredProperties) WR

HTMLTableFunctions::DoubleClickCell RJ SE

HTMLTableFunctions::RightClickCell RJ SE

HTMLTableFunctions::SelectCell RJ SE

HTMLTableFunctions::SelectCellContainsTextFind RJ SE

HTMLTableFunctions::SelectCellText RJ SE

HTMLTableFunctions::SelectCellTextFind RJ SE

HTMLTableFunctions::SelectCellTextSpecial RJ

HTMLTableFunctions::SelectFuzzyCellText RJ SE

HTMLTableFunctions::SelectFuzzyCellTextFind RJ SE

HTMLTableFunctions::VerifyCellEditable RJ SE

HTMLTableFunctions::VerifyCellText RJ SE

HTMLTableFunctions::VerifyCellTextContains RJ SE

HTMLTableFunctions::VerifyCellTextFind RJ SE

HTMLTableFunctions::VerifyCellValue RJ WR SE

HTMLTableFunctions::VerifyColumnLabel RJ SE

HTMLTableFunctions::VerifyFuzzyCellText RJ SE

HTMLTableFunctions::VerifyFuzzyCellTextContains RJ SE

HTMLTableFunctions::VerifyFuzzyCellTextFind RJ SE

HTMLTableFunctions::ActivateCell
RJ SE

HTMLTableFunctions::AssignCellContainsTextRow
RJ SE

HTMLTableFunctions::AssignCellTextRow
RJ SE

HTMLTableFunctions::AssignVariableCellText
RJ SE

HTMLTableFunctions::CaptureFuzzyRangeToFile
RJ SE

HTMLTableFunctions::CaptureRangeToFile
RJ SE

HTMLTableFunctions::Click (deprecated for: Generic CLICK)
WR

HTMLTableFunctions::ClickCell
RC RJ WR SE

HTMLTableFunctions::CompareStoredData (deprecated for: Generic CompareStoredData)
WR

HTMLTableFunctions::CompareStoredProperties (deprecated for: Generic CompareStoredProperties)
WR

HTMLTableFunctions::DoubleClickCell
RJ SE

HTMLTableFunctions::RightClickCell
RJ SE

HTMLTableFunctions::SelectCell
RJ SE

HTMLTableFunctions::SelectCellContainsTextFind
RJ SE

HTMLTableFunctions::SelectCellText
RJ SE

HTMLTableFunctions::SelectCellTextFind
RJ SE

HTMLTableFunctions::SelectCellTextSpecial
RJ

HTMLTableFunctions::SelectFuzzyCellText
RJ SE

HTMLTableFunctions::SelectFuzzyCellTextFind
RJ SE

HTMLTableFunctions::VerifyCellEditable
RJ SE

HTMLTableFunctions::VerifyCellText
RJ SE

HTMLTableFunctions::VerifyCellTextContains
RJ SE

HTMLTableFunctions::VerifyCellTextFind
RJ SE

HTMLTableFunctions::VerifyCellValue
RJ WR SE

HTMLTableFunctions::VerifyColumnLabel
RJ SE

HTMLTableFunctions::VerifyFuzzyCellText
RJ SE

HTMLTableFunctions::VerifyFuzzyCellTextContains
RJ SE

HTMLTableFunctions::VerifyFuzzyCellTextFind
RJ SE