C1FlexGrid

WinForms. C1FlexGrid

C1FlexGrid

Constructor

new C1FlexGrid()

A ComponentOne C1FlexGrid control.

Methods

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

Double-clicks the specified cell in this grid..
Parameters:
NameTypeDescription
rownumber0-based row number.
columnHeaderstringThe column caption.
Returns:
a promise that is fulfilled when the activateCell operation ends.
Type
Promise.<void>

cells(rowIndex[opt], columnIndex[opt]) → {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:
NameTypeAttributesDescription
rowIndexnumber <optional>
The row index of the specific cell.
columnIndexnumber <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:
NameTypeDescription
rownumberThe 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:
NameTypeDescription
rownumberThe 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:
NameTypeDescription
rownumber0-based row number.
columnOrColumnHeaderstring | number0-based column index or column caption.
Returns:
the C1TableCell.
Type
WinForms.C1TableCell

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

Scrolls the specified cell into view.
Parameters:
NameTypeDescription
rownumber0-based row number.
columnHeaderstringThe 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:
NameTypeDescription
rownumber0-based row number.
columnstring | number0-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:
NameTypeDescription
rownumber0-based row number.
columnHeaderstringThe 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:
NameTypeDescription
columnstring | numberThe 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:
NameTypeDescription
columnstring | numberThe column 0-based index or column caption.
filterstringa 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:
NameTypeDescription
columnstring | numberThe 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:
NameTypeDescription
columnstring | numberThe 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