Used within the cfform tag. Puts a grid control (a table of data) in a CFML form. To specify grid columns and row data, use the cfgridcolumn and cfgridrow tags, or use the query attribute, with or without cfgridcolumn tags.
<cfgrid name="">
cfgrid(name="");
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | Yes | Name of grid element. | |
| bind | string | No | A bind expression specifying used to fill the contents of the grid. Cannot be used with the query attribute. |
|
| pagesize | numeric | No | The number of rows to display per page for a dynamic grid. If the number of available rows exceeds the page size, the grid displays only the specified number of entries on a single page, and the user navigates between pages to show all data. The grid retrieves data for each page only when it is required for display. This attribute is ignored if you specify a query attribute. |
|
| striperowcolor | string | No | The color to use for one of the alternating stripes. The bgColor setting determines the other color |
|
| preservepageonsort | boolean | No | YES | Specifies whether to display the page with the current page number, or display page 1, after sorting (or resorting) the grid |
| striperows | boolean | No | YES | Specifies whether to display the page with the current page number, or display page 1, after sorting (or resorting) the grid |
| format | string | No | applet | - applet: generates a Java applet. - Flash: generates a Flash grid control. - xml: generates an XMLrepresentation of the grid. In XML format forms, includes the generated XML in the form. In HTML format forms, puts the XML in a string variable with the name specified by the name attribute. Default: applet |
| height | numeric | No | 300 | Control’s height, in pixels. Default for applet: 300 |
| width | numeric | No | Control’s width, in pixels. Default for applet: 300 |
|
| autowidth | boolean | No | NO | Yes: sets column widths so that all columns display within grid width. No: sets columns to equal widths. User can resize columns. Horizontal scroll bars are not available, because if you specify a column width and set autoWidth = “Yes”, CFML sets to this width, if possible |
| vspace | numeric | No | Vertical margin above and below control, in pixels. | |
| hspace | numeric | No | Horizontal spacing to left and right of control, in pixels. | |
| align | string | No | Alignment of the grid cell contents | |
| query | query | No | Name of query associated with grid control. | |
| insert | boolean | No | NO | User can insert row data in grid. Takes effect only if selectmode=”edit” |
| delete | boolean | No | NO | User can delete row data from grid. Takes effect only if selectmode=”edit” |
| sort | boolean | No | NO | The sort button performs simple text sort on column. User can sort columns by clicking column head or by clicking sort buttons. Not valid with selectmode=browse. Yes: sort buttons display on grid control |
| font | string | No | arial | Font of data in column. |
| fontsize | numeric | No | Size of text in column. | |
| italic | boolean | No | NO | Yes: displays grid control text in italics |
| bold | boolean | No | NO | Yes: displays grid control text in bold |
| textcolor | string | No | black | Text color for control. For a hex value, use the form: textColor = “##xxxxxx”, where x = 0-9 or A-F; use two hash signs or none. |
| href | string | No | URL or query column name that contains a URL to hyperlink each grid column with. |
|
| hrefkey | string | No | The query column to use for the value appended to the href URL of each column, instead of the column’s value. |
|
| target | string | No | Frame in which to open link specified in href. | |
| appendkey | boolean | No | YES | When used with href, passes CFTREEITEMKEY variable with the value of the selected tree item in URL to the application page specified in the cfform action attribute |
| highlighthref | boolean | No | YES | Yes: Highlights links that are associated with a cftreeitem with a URL attribute value. No: Disables highlight. |
| onvalidate | string | No | JavaScript function to validate user input. The form object, input object, and input object value are passed to the specified routine, which should return True if validation succeeds; False, otherwise. |
|
| onerror | string | No | JavaScript function to execute if validation fails. | |
| griddataalign | string | No | left | Left: left-aligns data within column. Right: right-aligns data within column. Center: center-aligns data within column. |
| gridlines | boolean | No | YES | Yes: enables row and column rules in grid control |
| rowheight | numeric | No | Minimum row height, in pixels, of grid control. Used with cfgridcolumn type = “Image”; defines space for graphics to display in row. |
|
| rowheaders | boolean | No | YES | Yes: displays a column of numeric row labels in grid control |
| rowheaderalign | string | No | left | Left: left-aligns data within row header Right: right-aligns data within row header Center: center-aligns data within row header |
| rowheaderfont | string | No | Font of data in column. | |
| rowheaderfontsize | numeric | No | Size of text in column. | |
| rowheaderitalic | boolean | No | NO | Yes: displays grid control text in italics |
| rowheaderbold | boolean | No | NO | Yes: displays grid control text in bold |
| rowheadertextcolor | string | No | black | Text color for control. For a hex value, use the form: textColor = “##xxxxxx”, where x = 0-9 or A-F; use two hash signs or none. |
| colheaders | boolean | No | YES | Yes: displays a column of numeric row labels in grid control |
| colheaderalign | string | No | left | Left: left-aligns data within row header Right: right-aligns data within row header Center: center-aligns data within row header |
| colheaderfont | string | No | Font of data in column. | |
| colheaderfontsize | numeric | No | Size of text in column. | |
| colheaderitalic | boolean | No | NO | Yes: displays grid control text in italics |
| colheaderbold | boolean | No | NO | Yes: displays grid control text in bold |
| colheadertextcolor | string | No | Text color for control. For a hex value, use the form: textColor = “##xxxxxx”, where x = 0-9 or A-F; use two hash signs or none. |
|
| bgcolor | string | No | Background color of grid control. | |
| selectcolor | string | No | Background color for a selected item. | |
| selectmode | string | No | Selection mode for items in the control. - Edit: user can edit grid data. Selecting a cell opens the editor for the cell type. - Row: user selections automatically extend to the row that contains selected cell. - Single: user selections are limited to selected cell. (Applet only) - Column: user selections automatically extend to column that contains selected cell. (Applet only) - Browse: user can only browse grid data. (Applet only) |
|
| maxrows | numeric | No | Maximum number of rows to display in grid. | |
| notsupported | string | No | Browser must support Java to view ColdFusion Java Applets! |
Text to display if a page that contains a Java applet-based cfform control is opened by a browser that does not support Java or has Java support disabled. |
| picturebar | boolean | No | NO | Yes: images for Insert, Delete, Sort buttons |
| insertbutton | string | No | Text for the insert button. Takes effect only if selectmode=”edit”. |
|
| deletebutton | string | No | Text of Delete button text. Takes effect only if selectmode=”edit”. |
|
| sortascendingbutton | string | No | Sort button text | |
| sortdescendingbutton | string | No | Sort button text | |
| style | string | No | Flash only: Must be a style specification in CSS format. Ignored for type=”text”. |
|
| enabled | boolean | No | YES | Flash only: Boolean value specifying whether the control is enabled. A disabled control appears in light gray. Default: true |
| visible | boolean | No | YES | Flash only: Boolean value specifying whether to show the control. Space that would be occupied by an invisible control is blank. Default: true |
| tooltip | string | No | Flash only: text to display when the mouse pointer hovers over the control. |
|
| onchange | string | No | Flash only: ActionScript to run when the control changes due to user action in the control. |
|
| bindonload | boolean | No | YES | * yes: executes the bind attribute expression when first loading the form. * no: does not execute the bind attribute expression until the first bound event. Ignored if there is no bind attribute. |
| selectonload | boolean | No | YES | * yes: selects the first row of the grid when the grid loads. * no: does not select any rows when the grid loads. |
| onblur | string | No | ActionScript that runs when the grid loses focus. | |
| onfocus | string | No | ActionScript that runs when the grid gets focus. | |
| collapsible | boolean | No | A Boolean value specifying whether the user can collapse the entire grid by clicking an arrow on the title bar. | |
| groupfield | string | No | Puts the grid rows into groups, organized by the column specified in this attribute. Each group is collapsible and has a header with the column name, group field value, and number of entries in the group. | |
| onLoad | string | No | Java Script function that gets called when a grid is loaded for first time |
The CFgrid and related tags offer a LOT of capability and many options, but if you just need a very simple demonstration of a working grid, here you go.
<cfform>
<cfgrid name="grid1" format="html" >
<cfgridcolumn name="col1">
<cfgridrow data="xxx">
</cfgrid>
</cfform>