cfgrid

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="");

This tag requires Adobe ColdFusion. Not supported on Lucee, OpenBD, etc.

Attribute Reference for the cfgrid tag

name

Required: Yes
Name of grid element.

bind

Required: No
A bind expression specifying used to fill the
contents of the grid. Cannot be used with the
query attribute.

pagesize

Required: 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

Required: No
The color to use for one of the alternating
stripes. The bgColor setting determines the
other color

preservepageonsort

Required: No
Default: YES
Specifies whether to display the page with
the current page number, or display page 1,
after sorting (or resorting) the grid

striperows

Required: No
Default: YES
Specifies whether to display the page with
the current page number, or display page 1,
after sorting (or resorting) the grid

format

Required: No
Default: 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 Values:
  • applet
  • flash
  • xml
  • html

height

Required: No
Default: 300
Control's height, in pixels.
Default for applet: 300

width

Required: No
Control's width, in pixels.
Default for applet: 300

autowidth

Required: No
Default: 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

Required: No
Vertical margin above and below control, in pixels.

hspace

Required: No
Horizontal spacing to left and right of control, in pixels.

align

Required: No
Alignment of the grid cell contents Values:
  • top
  • left
  • bottom
  • baseline
  • texttop
  • absbottom
  • middle
  • absmiddle
  • right

query

Required: No
Name of query associated with grid control.

insert

Required: No
Default: NO
User can insert row data in grid.
Takes effect only if selectmode="edit"

delete

Required: No
Default: NO
User can delete row data from grid.
Takes effect only if selectmode="edit"

sort

Required: No
Default: 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

Required: No
Default: arial
Font of data in column. Values:
  • arial
  • times
  • courier
  • arialunicodeMS

fontsize

Required: No
Size of text in column.

italic

Required: No
Default: NO
Yes: displays grid control text in italics

bold

Required: No
Default: NO
Yes: displays grid control text in bold

textcolor

Required: No
Default: 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. Values:
  • black
  • red
  • blue
  • magenta
  • cyan
  • orange
  • darkgray
  • pink
  • white
  • lightgray
  • yellow

href

Required: No
URL or query column name that contains a URL to hyperlink
each grid column with.

hrefkey

Required: No
The query column to use for the value appended to the href
URL of each column, instead of the column's value.

target

Required: No
Frame in which to open link specified in href.

appendkey

Required: No
Default: 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

Required: No
Default: YES
Yes: Highlights links that are associated with a cftreeitem
with a URL attribute value.
No: Disables highlight.

onvalidate

Required: 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

Required: No
JavaScript function to execute if validation fails.

griddataalign

Required: No
Default: left
Left: left-aligns data within column.
Right: right-aligns data within column.
Center: center-aligns data within column. Values:
  • left
  • center
  • right

gridlines

Required: No
Default: YES
Yes: enables row and column rules in grid control

rowheight

Required: No
Minimum row height, in pixels, of grid control. Used with
cfgridcolumn type = "Image"; defines space for graphics to
display in row.

rowheaders

Required: No
Default: YES
Yes: displays a column of numeric row labels in grid
control

rowheaderalign

Required: No
Default: left
Left: left-aligns data within row header
Right: right-aligns data within row header
Center: center-aligns data within row header Values:
  • left
  • center
  • right

rowheaderfont

Required: No
Font of data in column.

rowheaderfontsize

Required: No
Size of text in column.

rowheaderitalic

Required: No
Default: NO
Yes: displays grid control text in italics

rowheaderbold

Required: No
Default: NO
Yes: displays grid control text in bold

rowheadertextcolor

Required: No
Default: 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. Values:
  • black
  • red
  • blue
  • magenta
  • cyan
  • orange
  • darkgray
  • pink
  • white
  • lightgray
  • yellow

colheaders

Required: No
Default: YES
Yes: displays a column of numeric row labels in grid
control

colheaderalign

Required: No
Default: left
Left: left-aligns data within row header
Right: right-aligns data within row header
Center: center-aligns data within row header Values:
  • left
  • center
  • right

colheaderfont

Required: No
Font of data in column.

colheaderfontsize

Required: No
Size of text in column.

colheaderitalic

Required: No
Default: NO
Yes: displays grid control text in italics

colheaderbold

Required: No
Default: NO
Yes: displays grid control text in bold

colheadertextcolor

Required: 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. Values:
  • black
  • red
  • blue
  • magenta
  • cyan
  • orange
  • darkgray
  • pink
  • white
  • lightgray
  • yellow

bgcolor

Required: No
Background color of grid control. Values:
  • black
  • red
  • blue
  • magenta
  • cyan
  • orange
  • darkgray
  • pink
  • white
  • lightgray
  • yellow

selectcolor

Required: No
Background color for a selected item. Values:
  • black
  • red
  • blue
  • magenta
  • cyan
  • orange
  • darkgray
  • pink
  • white
  • lightgray
  • yellow

selectmode

Required: 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) Values:
  • edit
  • single
  • row
  • column
  • browse

maxrows

Required: No
Maximum number of rows to display in grid.

notsupported

Required: No
Default: <b>Browser must support Java to <br>view ColdFusion Java Applets!</b>
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!
"

picturebar

Required: No
Default: NO
Yes: images for Insert, Delete, Sort buttons

insertbutton

Required: No
Text for the insert button. Takes effect only if
selectmode="edit".

deletebutton

Required: No
Text of Delete button text. Takes effect only if
selectmode="edit".

sortascendingbutton

Required: No
Sort button text

sortdescendingbutton

Required: No
Sort button text

style

Required: No
Flash only: Must be a style specification in CSS format.
Ignored for type="text".

enabled

Required: No
Default: YES
Flash only: Boolean value specifying
whether the control is enabled. A disabled
control appears in light gray.
Default: true

visible

Required: No
Default: 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

Required: No
Flash only: text to display when the
mouse pointer hovers over the control.

onchange

Required: No
Flash only: ActionScript to run when the control changes
due to user action in the control.

bindonload

Required: No
Default: 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

Required: No
Default: YES
* yes: selects the first row of the grid when the gird loads.
* no: does not select any rows when the grid loads.

onblur

Required: No
ActionScript that runs when the grid loses focus.

onfocus

Required: No
ActionScript that runs when the grid gets focus.

collapsible

Required: No
A Boolean value specifying whether the user can collapse the entire grid by clicking an arrow on the title bar.

groupfield

Required: 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

Required: No
Java Script funtion that gets called when a grid is loaded for first time


Fork me on GitHub