This page is maintained for older versions of Rapise only. The latest documentation can be found at: https://rapisedoc.inflectra.com
Map Object

Map Object

Map Object

Represents an RVL Map object and all its operations. The same operations are used by the RVL runtime implicitly to read the cell value or iterate through the Map.

Actions

DoMoveToRow

DoMoveToRow(/**Number*/ colInd)

Moves to a given row.

rowInd Row index (or name) to set active.

DoSequential

DoSequential()

Advances to the next row in the range. The range is either set by SetRange or it is the default range that includes all rows on the sheet except first row which is considered to contain column names. When the end of the range is reached, DoSequential rewinds back to the first row in the range and returns 'false'.

Returns 'false' if being called when active row is the last row or the spreadsheet is not attached, 'true' - otherwise.

DoMoveToColumn

DoMoveToColumn(/**Number|String*/colInd)

Moves to a given column.

colInd Column index (or name) to set active.

DoMoveToFirstColumn

DoMoveToFirstColumn()

Moves to a first column in the map.

DoMoveToFirstRow

DoMoveToFirstRow()

Moves to a first row in the map.

DoMoveToLastColumn

DoMoveToLastColumn()

Moves to a last column in the map.

DoMoveToLastRow

DoMoveToLastRow()

Moves to a last row in the map.

Properties

Cell

** GetCell(/**Number|String*/ columnId, /**Number*/ rowId) **

Gets a cell value by its coordinates. It returns the current cell value after DoSequental or DoRandom if the parameters are not set.

[columnId] Column index or name. If not set ActiveColumn is used.

[rowId] Row index. If not set ActiveRow is used.

ColumnCell

** GetColumnCell(/**Number*/ rowId) **

Gets cell value by its coordinates. Returns current cell value after DoSequental. If not set ActiveColumn is used.

[rowId] Row index. If not set ActiveRow is used.

ColumnCount

** GetColumnCount() **

Gets columns count.

Returns Number of columns in the spreadsheet.

ColumnIndexByName

** GetColumnIndexByName(/**String*/name) **

Gets column name.

name Column name.

Returns column index if found, or -1.

ColumnName

** GetColumnName(/**Number*/ ind) **

Gets column name.

ind Column index.

Returns Name of column in the spreadsheet.

RowCount

** GetRowCount() **

Gets rows count.

Returns Number of rows in the spreadsheet.

RowIndexByName

** GetRowIndexByName(/**String*/name) **

Gets row name.

name Row name.

Returns row index if found, or -1.

CurrentRowIndex

** GetCurrentRowIndex() **

Get zero based current row index.

EOF

** GetEOF() **

Is current position is beyond the map boundaries range.

RowCell

** GetRowCell(/**Number|String*/ columnId) **

Gets cell value for current row. Returns current cell value after DoSequental. ActiveRow is used.

[columnId] Column index or name. If not set ActiveColumn is used.

RowName

** GetRowName(/**Number*/ ind) **

Gets row name.

ind Row index.

Returns Name of row in the map.

Value

** GetValue(/**Number|String*/ rowOrColumnNameOrId) **

Gets cell value by its name or id. Returns current cell value after DoSequental. If it is Rows or Table then the parameter needs to be a column name or index, and ActiveRow is used. If it is Columns then the parameter needs to be a row name or index, and ActiveRow is used.

[rowOrColumnNameOrId] Row or Column index or Name.