Share this page

# C1TrueDbGrid

## WinForms. C1TrueDbGrid

C1TrueDbGrid

## Constructor

## new C1TrueDbGrid()

A ComponentOne C1TrueDBGrid control.

# Methods

## activateCell(row, columnHeader) → {Promise.<void>}

Double-clicks the specified cell in this grid..

##### Parameters:

Name | Type | Description
--- | --- | ---
`row` | number | 0-based row number.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the activateCell operation ends.

Type
  Promise.<void>

## activateColumn(column) → {Promise.<void>}

Double-clicks a column by column index or header.

##### Parameters:

Name | Type | Description
--- | --- | ---
`column` | string | number | The column 0-based index or column caption.

##### Returns:

a promise that is fulfilled when the activateColumn operation ends.

Type
  Promise.<void>

## cells(rowIndexopt, columnIndexopt) → {Promise.<(Array.<Array.<WinForms.C1TableCell>>|Array.<WinForms.C1TableCell>)>|WinForms.C1TableCell}

Returns either a promise for all the cells in the table (when called without arguments), or all the cells in a row (when called with row only), or for the specified cell.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`rowIndex` | number | <optional> | The row index of the specific cell.
`columnIndex` | number | <optional> | The column index in the row, specified by the row parameter.

##### Returns:

either a promise for all the cells in the table (when called without arguments), or all the cells in a row (when called with row only), or for the specified cell.

Type
  Promise.<(Array.<Array.<WinForms.C1TableCell>>|Array.<WinForms.C1TableCell>)> | WinForms.C1TableCell

## collapseRow(row) → {Promise.<void>}

Collapses the specified row.

##### Parameters:

Name | Type | Description
--- | --- | ---
`row` | number | The 0-based row index.

##### Returns:

a promise that is fulfilled when the collapseRow operation ends.

Type
  Promise.<void>

## expandRow(row) → {Promise.<void>}

Expands the specified row.

##### Parameters:

Name | Type | Description
--- | --- | ---
`row` | number | The 0-based row index.

##### Returns:

a promise that is fulfilled when the expandRow operation ends.

Type
  Promise.<void>

## getCell(row, columnOrColumnHeader) → {WinForms.C1TableCell}

Returns the specified cell.

##### Parameters:

Name | Type | Description
--- | --- | ---
`row` | number | 0-based row number.
`columnOrColumnHeader` | string | number | 0-based column index or column caption.

##### Returns:

the C1TableCell.

Type
  WinForms.C1TableCell

## makeCellVisible(row, columnHeader) → {Promise.<void>}

Scrolls the specified cell into view.

##### Parameters:

Name | Type | Description
--- | --- | ---
`row` | number | 0-based row number.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the makeCellVisible operation ends.

Type
  Promise.<void>

## openCellElement(row, column) → {Promise.<void>}

Selects the specified cell and opens a cell's pop-up cell element.

##### Parameters:

Name | Type | Description
--- | --- | ---
`row` | number | 0-based row number.
`column` | string | number | 0-based column index or column caption.

##### Returns:

a promise that is fulfilled when the openCellElement operation ends.

Type
  Promise.<void>

## selectCell(row, columnHeader) → {Promise.<void>}

Selects the specified cell in this grid.

##### Parameters:

Name | Type | Description
--- | --- | ---
`row` | number | 0-based row number.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the selectCell operation ends.

Type
  Promise.<void>

## selectColumn(column) → {Promise.<void>}

Selects column by column index or column caption.

##### Parameters:

Name | Type | Description
--- | --- | ---
`column` | string | number | The column 0-based index or column caption.

##### Returns:

a promise that is fulfilled when the selectColumn operation ends.

Type
  Promise.<void>

## setFilter(column, filter) → {Promise.<void>}

Applies the specified filter string to the specified column.

##### Parameters:

Name | Type | Description
--- | --- | ---
`column` | string | number | The column 0-based index or column caption.
`filter` | string | a value in the column to be used as the filter

##### Returns:

a promise that is fulfilled when the setFilter operation ends.

Type
  Promise.<void>

## sort(column) → {Promise.<void>}

Sorts this table by the specified column (ascending).

##### Parameters:

Name | Type | Description
--- | --- | ---
`column` | string | number | The column 0-based index or column caption.

##### Returns:

a promise that is fulfilled when the sort operation ends.

Type
  Promise.<void>

## sortDescending(column) → {Promise.<void>}

Sorts this table by the specified column (descending).

##### Parameters:

Name | Type | Description
--- | --- | ---
`column` | string | number | The column 0-based index or column caption.

##### Returns:

a promise that is fulfilled when the sort operation ends.

Type
  Promise.<void>

## tableTestObject() → {WinForms.Table}

Returns the Table test object this custom grid was accessed from.

##### Returns:

the tableTestObject.

Type
  WinForms.Table

Tips to improve your search results... UFT Developer JavaScript SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: