FPSpreadFunctions
Last Updated:
Functions and Actions for FarPoint Spread objects.
This is not supported by Rational Robot out-of-the-box. You need
a proxy from one of IBM's 3rd party partners for this to work.
This proxy requires at least version 2003.06.15 of Robot.
FPSpreadFunctions::CaptureRangeToFile
Capture the grid data to the specified file. For now,
it can only be used to capture all of the grid data.
Fields: [ ]=
Optional with Default Value
-
CapturedFile
The name of the file used to save the captured data.
Typically, the captured file is stored in the Datapool\Test directory.
Captured files will be TAB delimited files.
This action only captures the data, it does not verify it against
a benchmark file.
Examples:
-
T, Window, FPSpreadGrid, CaptureRangeToFile, "captResult.txt"
The captured grid data will be saved into "captResult.txt" in the
Datapool\Test directory.
Since no optional block parameters are supported as of yet, the entire
grid is captured and compared.
[How To Read This Reference]
FPSpreadFunctions::ClickCell
Attempts to perform a single click on a table cell.
The cell to click is provided in separate row and col
parameters. Missing parameters indicate index=1. The
indexes are 1-based. That is, the first row is row 1.
The first col is col 1.
The row headers, whether visible or not, are considered
column 0. The column headers, whether visible or not,
are considered row 0.
Fields: [ ]=
Optional with Default Value
- [ row = ]
The 1-based logical row to click.
If no row is provided then row=1 is assumed. Row=0 is used
for column headers.
- [ col = ]
The 1-based logical col to click.
If no col is provided then col=1 is assumed. Col=0 is used
for row headers.
Examples:
-
T, AWindow, AGrid, ClickCell
Attempts to click the first data cell in the first
data row.
-
T, AWindow, AGrid, ClickCell, ^row=2, ^col=1
Attempts to click the first data cell in the second
data row.
Note, the DDVariables shown are not necessary but are
shown for clarity.
-
T, AWindow, AGrid, ClickCell, ^row=0, ^col=1
Attempts to click the first column header/label.
Note, the DDVariables shown are not necessary but are
shown for clarity.
[How To Read This Reference]
FPSpreadFunctions::CtrlClickCell
Attempts to perform a single Ctrl+Click on a table cell.
The cell to click is provided in separate row and col
parameters. Missing parameters indicate index=1. The
indexes are 1-based. That is, the first row is row 1.
The first col is col 1.
The row headers, whether visible or not, are considered
column 0. The column headers, whether visible or not,
are considered row 0.
Fields: [ ]=
Optional with Default Value
- [ row = ]
The 1-based logical row to Ctrl+Click.
If no row is provided then row=1 is assumed. Row=0 is used
for column headers.
- [ col = ]
The 1-based logical col to Ctrl+Click.
If no col is provided then col=1 is assumed. Col=0 is used
for row headers.
Examples:
-
T, AWindow, AGrid, CtrlClickCell
Attempts to Ctrl+Click the first data cell in the first
data row.
-
T, AWindow, AGrid, CtrlClickCell, ^row=2, ^col=1
Attempts to Ctrl+Click the first data cell in the second
data row.
Note, the DDVariables shown are not necessary but are
shown for clarity.
-
T, AWindow, AGrid, CtrlClickCell, ^row=0, ^col=1
Attempts to Ctrl+Click the first column header/label.
Note, the DDVariables shown are not necessary but are
shown for clarity.
[How To Read This Reference]
FPSpreadFunctions::DoubleClickCell
Attempts to perform a double click on a table cell.
The cell to double click is provided in separate row and col
parameters. Missing parameters indicate index=1. The
indexes are 1-based. That is, the first row is row 1.
The first col is col 1.
The row headers, whether visible or not, are considered
column 0. The column headers, whether visible or not,
are considered row 0.
Fields: [ ]=
Optional with Default Value
- [ row = ]
The 1-based logical row to double click.
If no row is provided then row=1 is assumed. Row=0 is used
for column headers.
- [ col = ]
The 1-based logical col to double click.
If no col is provided then col=1 is assumed. Col=0 is used
for row headers.
Examples:
-
T, AWindow, AGrid, DoubleClickCell
Attempts to double click the first data cell in the first
data row.
-
T, AWindow, AGrid, DoubleClickCell, ^row=2, ^col=1
Attempts to double click the first data cell in the second
data row.
Note, the DDVariables shown are not necessary but are
shown for clarity.
-
T, AWindow, AGrid, DoubleClickCell, ^row=0, ^col=1
Attempts to double click the first column header/label.
Note, the DDVariables shown are not necessary but are
shown for clarity.
[How To Read This Reference]
FPSpreadFunctions::FindRowNumber
Search specified columns for the specified text. Assign the
matching row number to the given variable.
Multiple (column, search text) pairs can be used as parameters
to find the matching row.
The search column and the search text parameters should have
the same number of parameters and are expected to work in
parallel (the first search text is looked for in the first
column listed).
The column name and search text parameters, if more than one,
use the delimiter specified to show the separation in the string.
Fields: [ ]=
Optional with Default Value
-
rowVarName
The name of the variable to store the row number into.
-
startingRow
The row to use to begin the search. Defaults to row 1.
-
searchColumns
The string of column names where you want to search.
You can have just a single column name, or multiple column
names separated by the specified delimiter.
- [ searchText = ]
The string of search strings used to search in each specified
column names.
The number of search strings you have should be equal to the
number of search columns that you have.
-
DELIMITER
Delimiter used by the search columns and search text to separate
the different columns/text.
Examples:
-
T, AWindow, AGrid, FindRowNumber, "foo", "", "Name", "Bar", "|"
Searches for the word "Bar" starting on row 1, in column
"Name" of the given grid. The returned row number is
stored in the variable foo.
-
T, AWindow, AGrid, FindRowNumber, "foo", "10", "Name|City", "Bar|Pittsburgh", "|"
Searches for the word "Bar" starting on row 10, in column
"Name" of the given grid. If found, it continues on the
same row to search for "Pittsburgh" in the column "City".
If that is found, the row number is stored in teh variable
foo. If either column does not match the search text,
nothing is stored in foo and the next row is considered.
[How To Read This Reference]
FPSpreadFunctions::RightClickCell
Attempts to perform a single right click on a table cell.
The cell to click is provided in separate row and col
parameters. Missing parameters indicate index=1. The
indexes are 1-based. That is, the first row is row 1.
The first col is col 1.
The row headers, whether visible or not, are considered
column 0. The column headers, whether visible or not,
are considered row 0.
Fields: [ ]=
Optional with Default Value
- [ row = ]
The 1-based logical row to right click.
If no row is provided then row=1 is assumed. Row=0 is used
for column headers.
- [ col = ]
The 1-based logical col to right click.
If no col is provided then col=1 is assumed. Col=0 is used
for row headers.
Examples:
-
T, AWindow, AGrid, RightClickCell
Attempts to right click the first data cell in the first
data row.
-
T, AWindow, AGrid, RightClickCell, ^row=2, ^col=1
Attempts to right click the first data cell in the second
data row.
Note, the DDVariables shown are not necessary but are
shown for clarity.
-
T, AWindow, AGrid, RightClickCell, ^row=0, ^col=1
Attempts to right click the first column header/label.
Note, the DDVariables shown are not necessary but are
shown for clarity.
[How To Read This Reference]
FPSpreadFunctions::ShiftClickCell
Attempts to perform a single SHIFT+Click on a table cell.
The cell to click is provided in separate row and col
parameters. Missing parameters indicate index=1. The
indexes are 1-based. That is, the first row is row 1.
The first col is col 1.
The row headers, whether visible or not, are considered
column 0. The column headers, whether visible or not,
are considered row 0.
Fields: [ ]=
Optional with Default Value
- [ row = ]
The 1-based logical row to SHIFT+Click.
If no row is provided then row=1 is assumed. Row=0 is used
for column headers.
- [ col = ]
The 1-based logical col to SHIFT+Click.
If no col is provided then col=1 is assumed. Col=0 is used
for row headers.
Examples:
-
T, AWindow, AGrid, ShiftClickCell
Attempts to SHIFT+Click the first data cell in the first
data row.
-
T, AWindow, AGrid, ShiftClickCell, ^row=2, ^col=1
Attempts to SHIFT+Click the first data cell in the second
data row.
Note, the DDVariables shown are not necessary but are
shown for clarity.
-
T, AWindow, AGrid, ShiftClickCell, ^row=0, ^col=1
Attempts to SHIFT+Click the first column header/label.
Note, the DDVariables shown are not necessary but are
shown for clarity.
[How To Read This Reference]
FPSpreadFunctions::VerifyCellText
Verify a specific cell's text.
Fields: [ ]=
Optional with Default Value
-
ExpectedCellText
The expected text value of the specified cell.
- [ row = ]
The 1-based logical row to verify.
If no row is provided then row=1 is assumed. Row=0 is used
for column headers.
- [ col = ]
The 1-based logical col to verify.
If no col is provided then col=1 is assumed. Col=0 is used
for row headers.
Examples:
-
T, AWindow, AGrid, VerifyCellText, "foo"
Attempts to verify that the first data cell in the first
data row is equal to "foo".
-
T, AWindow, AGrid, VerifyCellText, "foo", ^row=2, ^col=1
Attempts to verify that the first data cell in the second
data row is equal to "foo".
Note, the DDVariables shown are not necessary but are
shown for clarity.
-
T, AWindow, AGrid, VerifyCellText, "foo", ^row=0, ^col=1
Attempts to verify that the first column header/label is
equal to "foo".
Note, the DDVariables shown are not necessary but are
shown for clarity.
[How To Read This Reference]