new GridPattern()
The UIA Pro Grid pattern.
Methods
activateCell(row, column) → {Promise.<void>}
Activates (double-clicks) the specified cell in grid.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
column |
number | the 0-based ordinal number of the column of interest. |
Returns:
- Type
- Promise.<void>
addCellToSelection(row, column) → {Promise.<void>}
Selects a cell in addition to previously selected cells.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
column |
number | the 0-based ordinal number of the column of interest. |
Returns:
- Type
- Promise.<void>
addRowToSelection(row) → {Promise.<void>}
Selects a row in addition to previously selected rows.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
Returns:
- Type
- Promise.<void>
clickCell(row, column, mouseButton) → {Promise.<void>}
Clicks a specified cell in grid.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
column |
number | the 0-based ordinal number of the column of interest. |
mouseButton |
MouseButton | the mouse button to be used for this operation. |
Returns:
- Type
- Promise.<void>
columnCount() → {Promise.<number>}
Returns the number of columns in a grid.
Returns:
a promise that is fulfilled with the number of columns.
- Type
- Promise.<number>
getCell(row, column) → {Promise.<UIAPro.UiObject>}
Retrieves a UIAPro cell object representing an item in the grid.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
column |
number | the 0-based ordinal number of the column of interest. |
Returns:
a promise that is fulfilled with an UIAPro cell object.
- Type
- Promise.<UIAPro.UiObject>
getCellName(row, column) → {Promise.<string>}
Retrieves the name of a cell in the grid.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
column |
number | the 0-based ordinal number of the column of interest. |
Returns:
- Type
- Promise.<string>
getCellText(row, column) → {Promise.<string>}
Retrieves the text of a cell in the grid.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
column |
number | the 0-based ordinal number of the column of interest. |
Returns:
- Type
- Promise.<string>
getCellValue(row, column) → {Promise.<string>}
Retrieves the value of a cell in the grid.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
column |
number | the 0-based ordinal number of the column of interest. |
Returns:
- Type
- Promise.<string>
rowCount() → {Promise.<number>}
Returns the total number of rows in a grid.
Returns:
a promise that is fulfilled with the total number of rows.
- Type
- Promise.<number>
selectCell(row, column) → {Promise.<void>}
Selects a cell in the grid.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
column |
number | the 0-based ordinal number of the column of interest. |
Returns:
- Type
- Promise.<void>
selectRow(row) → {Promise.<void>}
Selects a row in the grid.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
Returns:
- Type
- Promise.<void>
setCellValue(row, column, value) → {Promise.<void>}
Sets a value of a cell in the grid.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
number | the 0-based ordinal number of the row of interest. |
column |
number | the 0-based ordinal number of the column of interest. |
value |
string | the value to set. |
Returns:
- Type
- Promise.<void>