Whatever message this page gives is out now! Go check it out!
ColdFusion.Layout.createTab
Last update:
May 18, 2026
Description
Creates a tab and layout area in a ColdFusion tabbed layout.
Function syntax
ColdFusion.Layout.createTab(layout, layoutArea, Title, URL [, configObject]) |
See also
Using layouts in Controlling Ajax user interface layout the Developing ColdFusion Applications
History
ColdFusion 8: Added this function
Parameters
Parameter | Description |
layout | The name attribute of the tabbed layout in which to add the tab |
layoutArea | The name to assign to the layout area that is created for the new tab. Must be unique on the page. |
title | The text to display on the tab. You can use HTML mark-up to control the title appearance. |
URL | The URL from which to get the layout area contents. This attribute can use URL parameters to pass data to the page. ColdFusion uses standard page path resolution rules to locate the page. |
configObject | An object containing window configuration parameters. For details, see "Usage". |
Returns
This function does not return a value.
Usage
This function dynamically creates tabs in a tabbed layout; it is equivalent to putting a cflayoutarea tag inside a cflayout tag with a type attribute of tab. The configuration parameter defines tab characteristics; it can have any or all the following entries:
Entry | Default | Description |
align | The cflayout tag align attribute value | Specifies how to align child controls within the layout area. The following values are valid:
|
callbackhandler | A function that is called when the layout tab body has loaded. This function must not take any arguments. | |
closable | false | A Boolean value specifying whether the user can close the window. If true, the tab has an X close icon. |
disabled | 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 grayed out. Ignored if there is a true selected entry. |
errorHandler | A function that is called if an error occurs in loading the tab body. This function must take two arguments:
| |
inithide | false | A Boolean value specifying whether the tab is initially hidden. To show an initially hidden tab, use the ColdFusion.Layout.showTab function. |
overflow | auto | Specifies how to display child content whose size would cause the tab layout area to overflow the window boundaries. The following values are valid:
Note: 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. |
selected | false | A Boolean value specifying whether this tab is initially selected so that its contents appears in the layout. |
style | A CSS style specification that controls the appearance of the layout area. |
Example
The following example creates a tabbed layout with one tab. When you click the button it creates a second tab that is immediately visible and selected.The main page looks as follows:
<html>
<head>
</head>
<body>
<cfform name="layouts">
<cfinput type="button" name="CreateTab"
onClick="ColdFusion.Layout.createTab('tabLayout','tab2',
'Tab 2','_tabUrl.cfm',{inithide:false,selected:true})"
value="Create Tab">
</cfform>
<cflayout type="tab" name="tabLayout">
<cflayoutarea name="tab1" title="Tab 1" align="left">
Default Tab
</cflayoutarea>
</cflayout>
</body>
</html>The _tabURL.cfm page looks as follows:
<h3>Tab 2</h3>
This is a simple tab
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
