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.

cfgrid Attribute Reference

name
Required

Name of grid element.

bind

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

pagesize

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

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

preservepageonsort
Default: YES

Specifies whether to display the page with
the current page number, or display page 1,
after sorting (or resorting) the grid

striperows
Default: YES

Specifies whether to display the page with
the current page number, or display page 1,
after sorting (or resorting) the grid

format
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
Default: 300

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

width

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

autowidth
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

Vertical margin above and below control, in pixels.

hspace

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

align

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

query

Name of query associated with grid control.

insert
Default: NO

User can insert row data in grid.
Takes effect only if selectmode="edit"

delete
Default: NO

User can delete row data from grid.
Takes effect only if selectmode="edit"

sort
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
Default: arial

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

fontsize

Size of text in column.

italic
Default: NO

Yes: displays grid control text in italics

bold
Default: NO

Yes: displays grid control text in bold

textcolor
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

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

hrefkey

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

target

Frame in which to open link specified in href.

appendkey
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
Default: YES

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

onvalidate

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

JavaScript function to execute if validation fails.

griddataalign
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
Default: YES

Yes: enables row and column rules in grid control

rowheight

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

rowheaders
Default: YES

Yes: displays a column of numeric row labels in grid
control

rowheaderalign
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

Font of data in column.

rowheaderfontsize

Size of text in column.

rowheaderitalic
Default: NO

Yes: displays grid control text in italics

rowheaderbold
Default: NO

Yes: displays grid control text in bold

rowheadertextcolor
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
Default: YES

Yes: displays a column of numeric row labels in grid
control

colheaderalign
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

Font of data in column.

colheaderfontsize

Size of text in column.

colheaderitalic
Default: NO

Yes: displays grid control text in italics

colheaderbold
Default: NO

Yes: displays grid control text in bold

colheadertextcolor

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

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

selectcolor

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

selectmode

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

Maximum number of rows to display in grid.

notsupported
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
Default: NO

Yes: images for Insert, Delete, Sort buttons

insertbutton

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

deletebutton

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

sortascendingbutton

Sort button text

sortdescendingbutton

Sort button text

style

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

enabled
Default: YES

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

visible
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

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

onchange

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

bindonload
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
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

ActionScript that runs when the grid loses focus.

onfocus

ActionScript that runs when the grid gets focus.

collapsible

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

groupfield

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

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

Fork me on GitHub