The class that represents a column list.
All indexes are zero based.
new ColumnList();
Name | Description |
None. |
Name | Type | Descripton |
None. |
Name | Description | ||||||||||||
addRowSyntax
Arguments
Return Type
| Appends supplied row to the column list. | ||||||||||||
addRowsSyntax
Arguments
Return Type
| Appends supplied rows to the column list. | ||||||||||||
bindSyntax
Arguments
Return Type
| Binds column list to an existing HTML structure. See the usage instructions for further information. | ||||||||||||
calcSizeSyntax
ArgumentsNo Arguments. Return Type
| Recalculates the size of the column list widget. Should be called if the size of the outermost container is changed. | ||||||||||||
clearSyntax
Arguments
Return Type
| Removes all rows from column list. | ||||||||||||
createSyntax
Arguments
Return Type
| Transforms the supplied container into an empty column list. | ||||||||||||
getCellValueSyntax
Arguments
Return Type
| Returns the content of the specified cell. | ||||||||||||
getColumnCountSyntax
ArgumentsNo Arguments. Return Type
| Returns the number of columns in the column list. | ||||||||||||
getRowCountSyntax
ArgumentsNo Arguments. Return Type
| Returns the number of rows in the column list. | ||||||||||||
getSelectedRangeSyntax
ArgumentsNo Arguments. Return Type
| Returns an array containing the row indexes of all selected rows. | ||||||||||||
getSelectedRowSyntax
ArgumentsNo Arguments. Return Type
| Returns the row index of the selected row. If multiple rows are selected the first one is returned. | ||||||||||||
removeRangeSyntax
Arguments
Return Type
| Removes all rows in the range defined by the iFromRowIndex and iToRowIndex parameters. | ||||||||||||
removeRangeSyntax
Arguments
Return Type
| Removes all rows specified in the iRowIndex parameter. | ||||||||||||
removeRowSyntax
Arguments
Return Type
| Removes the row identified by the sequence number supplied. | ||||||||||||
resizeSyntax
Arguments
Return Type
| Resize the grid to the given dimensions, the outer (border) size is given, not the inner (content) size. | ||||||||||||
selectRangeSyntax
Arguments
Return Type
| Selects all rows in the range defined by the iFromRowIndex and iToRowIndex parameters. | ||||||||||||
selectRangeSyntax
Arguments
Return Type
| Selects all rows specified in the iRowIndex parameter. | ||||||||||||
selectRowSyntax
Arguments
Return Type
| Selects the row identified by the sequence number supplied. | ||||||||||||
setCellValueSyntax
Arguments
Return Type
| Sets the content of the specified cell. | ||||||||||||
setColumnAlignmentSyntax
Arguments
Return Type
| Sets column text alignment. | ||||||||||||
setColumnTypesSyntax
Arguments
Return Type
| Sets the column data types. Used to determine alignment and sorting. | ||||||||||||
setSortTypesSyntax
Arguments
Return Type
| Sets the column data types. Used to determine alignment and sorting. | ||||||||||||
sortSyntax
Arguments
Return Type
| Sorts the column list by the specified column. |
Name | Type | Descripton |
bodyColResize | Boolean | If enabled the size of the body columns will be updated as the header column is resized, if not the size of the body columns won't update until resize operation has completed. |
colorEvenRows | Boolean | If enabled odd and even rows will have different class names (odd and even) to allow their background color to be different. |
columnAlign | Boolean | Enable column text alignment. If enabled the text alignment of columns can be set explicitly or determined implicit based on column data type. |
columnSorting | Boolean | Enable column sorting. If enabled sort order can be set by clicking the column headers. |
error | String | Read only. If a method has returned an error code this property will contain an error message. |
moveColumns | Boolean | Enable column moving. If enabled columns can be reorganized using drag and drop. |
multiple | Boolean | If true multiple selection is allowed, if false it's not. |
resizeColumns | Boolean | Enable column resizing. If enabled the columns may be resized by dragging the border between two column headers. |
rowSelection | Boolean | Enable column selection. If enabled rows can be selected using either the mouse or keyboard. |
selectedRows | Number[] | Read only. An array containing the indexes of all selected rows. |
sortAscImage | String | Image used to indicate ascending sort order |
sortCol | Number | Read only. Indicates which column the column list is sorted by or -1 if it is not sorted. |
sortDescending | Boolean | Read only. Indicates sort direction. False for ascending, true for descending. |
sortDescImage | String | Image used to indicate descending sort order |
Name | Descripton |
onresize | Reference to function that will be called when the widget has been resized. |
onselect | Reference to function that will be called when a row has been selected. |
onsort | Reference to function that will be called when a sort operation has been performed. |
None.