cfgrid

Overview ColdFusion Open BlueDragon Lucee

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.

Attributes

Name Required Type Default Description
align No String Alignment of the grid cell contents
appendkey No Boolean true 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
autowidth No Boolean false 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
bgcolor No String Background color of grid control.
8
bind No String A bind expression specifying used to fill the contents of the grid. Cannot be used with the query attribute.
8
bindonload No Boolean true * 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.
bold No Boolean false Yes: displays grid control text in bold
colheaderalign No String left Left: left-aligns data within row header Right: right-aligns data within row header Center: center-aligns data within row header
colheaderbold No Boolean false Yes: displays grid control text in bold
colheaderfont No String Font of data in column.
colheaderfontsize No Numeric Size of text in column.
colheaderitalic No Boolean false Yes: displays grid control text in italics
colheaders No Boolean true Yes: displays a column of numeric row labels in grid control
colheadertextcolor No String 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.
9
collapsible No Boolean A Boolean value specifying whether the user can collapse the entire grid by clicking an arrow on the title bar.
delete No Boolean false User can delete row data from grid. Takes effect only if selectmode="edit"
deletebutton No String Text of Delete button text. Takes effect only if selectmode="edit".
enabled No Boolean true Flash only: Boolean value specifying whether the control is enabled. A disabled control appears in light gray. Default: true
font No String arial Font of data in column.
fontsize No Numeric Size of text in column.
format No String 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
griddataalign No String left Left: left-aligns data within column. Right: right-aligns data within column. Center: center-aligns data within column.
gridlines No Boolean true Yes: enables row and column rules in grid control
9
groupfield No String 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.
height No Numeric 300 Control's height, in pixels. Default for applet: 300
highlighthref No Boolean true Yes: Highlights links that are associated with a cftreeitem with a URL attribute value. No: Disables highlight.
href No String URL or query column name that contains a URL to hyperlink each grid column with.
hrefkey No String The query column to use for the value appended to the href URL of each column, instead of the column's value.
hspace No Numeric Horizontal spacing to left and right of control, in pixels.
insert No Boolean false User can insert row data in grid. Takes effect only if selectmode="edit"
insertbutton No String Text for the insert button. Takes effect only if selectmode="edit".
italic No Boolean false Yes: displays grid control text in italics
maxrows No Numeric Maximum number of rows to display in grid.
9
multiRowSelect No Boolean If set to true, a checkbox appears as the first column of the grid. It lets users select multiple records.
name Yes String Name of grid element.
notsupported No String 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. Default: "Browser must support Java to
view ColdFusion Java Applets!
"
8
onblur No String ActionScript that runs when the grid loses focus.
onchange No String Flash only: ActionScript to run when the control changes due to user action in the control.
onerror No String JavaScript function to execute if validation fails.
8
onfocus No String ActionScript that runs when the grid gets focus.
9
onLoad No String Java Script funtion that gets called when a grid is loaded for first time
onvalidate No String 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.
8
pagesize No Numeric 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.
picturebar No Boolean false Yes: images for Insert, Delete, Sort buttons
8
preservepageonsort No Boolean true Specifies whether to display the page with the current page number, or display page 1, after sorting (or resorting) the grid
query No Query Name of query associated with grid control.
rowheaderalign No String left Left: left-aligns data within row header Right: right-aligns data within row header Center: center-aligns data within row header
rowheaderbold No Boolean false Yes: displays grid control text in bold
rowheaderfont No String Font of data in column.
rowheaderfontsize No Numeric Size of text in column.
rowheaderitalic No Boolean false Yes: displays grid control text in italics
rowheaders No Boolean true Yes: displays a column of numeric row labels in grid control
rowheadertextcolor No String 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.
rowheaderwidth No The width, in pixels, of the row header column.
rowheight No Numeric Minimum row height, in pixels, of grid control. Used with cfgridcolumn type = "Image"; defines space for graphics to display in row.
selectcolor No String Background color for a selected item.
selectmode No String 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)
8
selectonload No Boolean true * yes: selects the first row of the grid when the gird loads. * no: does not select any rows when the grid loads.
sort No Boolean false 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
sortascendingbutton No String Sort button text
sortdescendingbutton No String Sort button text
8
striperowcolor No String The color to use for one of the alternating stripes. The bgColor setting determines the other color
8
striperows No Boolean true Specifies whether to display the page with the current page number, or display page 1, after sorting (or resorting) the grid
style No String Flash only: Must be a style specification in CSS format. Ignored for type="text".
target No String Frame in which to open link specified in href.
textcolor No String 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.
tooltip No String Flash only: text to display when the mouse pointer hovers over the control.
visible No Boolean true Flash only: Boolean value specifying whether to show the control. Space that would be occupied by an invisible control is blank. Default: true
vspace No Numeric Vertical margin above and below control, in pixels.
width No Numeric Control's width, in pixels. Default for applet: 300