To learn more about using JavaScript in LeanFT, see Setting up and working with the JavaScript SDK.
For JavaScript code samples, see Code Samples - JavaScript.

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>

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