Description
Sorts the specified HTML grid.
Function syntax
ColdFusion.Grid.sort(name [, columnName, direction]) |
See also
cfgrid, ColdFusion.Grid.getGridObject, ColdFusion.Grid.refresh, ExtJS - JavaScript Library Documentation, Using HTML grids in the Developing ColdFusion Applications
History
ColdFusion 8: Added this function
Parameters
Parameter |
Description |
|---|---|
name |
The value of the name attribute of the cfgrid tag to sort. |
columnName |
The name of the column that determines the sort order. |
direction |
The sort direction. Must be one for these values:
|
Returns
This function does not return a value.
Usage
This function sorts the data displayed by the grid by using a case-insensitive sort for string data, or a numeric sort for numeric data. It uses the specified column contents to determine the displayed grid order. When a grid has a remote data source, the bound CFC function that provides the data gets the column name and sort direction in the cfgridsortcolumn and cfgridsortdirection bind attributes. The CFC function must use these values and perform the sort appropriately.