cflayoutarea

Defines a region within a cflayout tag body, such as an
individual tab of a tabbed layout. This tag is not used in
Flash forms.

  <cflayoutarea>

 cflayoutarea();

This tag requires Adobe ColdFusion 8 and up.  Not supported on Lucee, etc.

Discouraged: The use of tags generating UI is generally discouraged by the CFML community. See: http://static.raymondcamden.com/cfuitherightway/cfpod/index.html

Attribute Reference

position string
Default: top

The position...(docs don't explain this one).
Values:
  • bottom
  • center
  • left
  • right
  • top

align string
Default: center

Specifies how to align child controls within the
layout area.
Values:
  • center
  • justify
  • left
  • right

closable boolean
Default: false

A Boolean value specifying whether the area can close.
Specifying this attribute adds an x icon on the tab or
title bar that a user can click to close the area.
You cannot use this attribute for border layout areas
with a position attribute value of center.
Values:
  • true
  • false

collapsible boolean
Default: false

A Boolean value specifying whether the area can collapse.
Specifying this attribute adds a >> or << icon on the
title bar that a user can click to collapse the area.
You cannot use this attribute for border layout areas
with a position attribute value of center.
Values:
  • true
  • false

disabled boolean
Default: false

A Boolean value specifying whether the tab is disabled,
that is, whether user can select the tab to display its
contents. Disabled tabs are greyed out. Ignored if the
selected attribute value is true.
Values:
  • true
  • false

initCollapsed boolean
Default: false

A Boolean value specifying whether the area is initially
collapsed. You cannot use this attribute for border layout
areas with a position attribute value of center. Ignored
if the collapsible attribute value is false.
Values:
  • true
  • false

initHide boolean
Default: false

A Boolean value specifying whether the area is initially
hidden. To show an initially hidden area, use the
ColdFusion.Layout.showArea or ColdFusion.Layout.showTab
function. You cannot use this attribute for border layout
areas with a position attribute value of center.
Values:
  • true
  • false

maxSize numeric

For layouts with top or bottom position attributes, the maximum
height of the area, in pixels, that you can set by dragging a
splitter. For layouts with left or right position attributes,
the maximum width of the area. You cannot use this attribute
for border layout areas with a position attribute value of
center.

minSize numeric

For layouts with top or bottom position attributes, the minimum
height of the area, in pixels, that you can set by dragging a
splitter. For layouts with left or right position attributes,
the minimum width of the area., You cannot use this attribute
for border layout areas with a position attribute value of center.

name string

The name of the layout area.

onBindError string

The name of a JavaScript function to execute if evaluating a
bind expression results in an error. The function must take
two attributes: an HTTP status code and a message. If you omit
this attribute, and have specified a global error handler
(by using the ColdFusion.setGlobalErrorHandlerfunction ),
it displays the error message; otherwise a default error
pop-up displays.

overflow string
Default: auto

Specifies how to display child content whose size would cause
the control to overflow the window boundaries. ÔøΩ In Internet Explorer, layout areas with
the visible setting expand to fit the size of the contents,
rather than having the contents extend beyond the layout area.
Values:
  • auto
  • hidden
  • scroll
  • visible

selected boolean

A Boolean value specifying whether this tab is initially
selected so that its contents appears in the layout.
Values:
  • true
  • false

size numeric

For hbox layouts and border layouts with top or bottom position
attributes, the initial height of the area. For vbox layouts
and border layouts with left or right position attributes, the
initial width of the area. For hbox and vbox layouts, you can
use any valid CSS length or percent format
(such as 10, 10% 10px, or 10em) for this attribute. For border
layouts, this attribute value must be an integer number of
pixels. You cannot use this attribute for border layout areas
with a position attribute value of center. ColdFusion
automatically determines the center size based on the
size of all other layout areas.

source string

A URL that returns the layout area contents. ColdFusion uses
standard page path resolution rules. You can use a bind expression
with dependencies in this attribute. If file specified in this
attribute includes tags that use AJAX features, such as cfform,
cfgrid, and cfpod, you must use the cfajaximport tag on the page
that includes the cflayoutarea tag. For more information,
see cfajaximport.

splitter boolean
Default: false

A Boolean value specifying whether the layout area has a divider
between it and the adjacent layoutarea control. Users can drag the
splitter to change the relative sizes of the areas. If this
attribute is set true on a left or right position layout area,
the splitter resizes the area and its adjacent area horizontally.
If this attribute is set true on a top or bottom position
layout area, the splitter resizes the layout vertically.
You cannot use this attribute for border layout areas with
a position attribute value of center
Values:
  • true
  • false

style string

A CSS style specification that controls the appearance of the area.

title string

For tab layouts, the text to display on the tab. For border
layouts, if you specify this attribute ColdFusion creates
a title bar for the layout area with the specified text as
the title. By default, these layouts do not have a title
bar if they are not closable or collapsible. You cannot
use this attribute for border layout areas with a position
attribute value of center.

refreshonactivate boolean
Default: false

* true: Refresh the contents of the tab by running the source bind expression whenever the tab display region shows (for example, when the user selects the tab), in addition to when bind events occur.
* false: Refresh the tab display region only when the bind expression is triggered by its bind event.
Values:
  • true
  • false

titleIcon string

Specifies the location of the icon to display with the title.

bindOnLoad boolean

A Boolean value that specifies whether to execute
the bind attribute expression when first loading the
form. Ignored if there is no bind attribute.
Values:
  • true
  • false

Examples
Sample code using the cflayoutarea tag

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub