ColdFusion.Layout.collapseArea

Description

Collapses an area of a border layout.

Function syntax

ColdFusion.Layout.collapseArea(layout, layoutArea)

See also

cflayout, cflayoutarea, ColdFusion.Layout.expandArea, ColdFusion.Layout.getTabLayout, ColdFusion.Layout.showArea, Using layouts in the Developing ColdFusion Applications

History

ColdFusion 8: Added this function

Parameters

Parameter

Description

layout

The name attribute of the border layout that contains the area to collapse.

layoutArea

The position in the layout of the area to collapse. Must be one of the following: bottom, left, right, or top.

Returns

This function does not return a value.

Usage

This function has no effect if the area is already collapsed.

Example

The following code snippet collapses the left area of the layout border layout when the user clicks the button.

<cfinput name="collapse2" width="100" value="Collapse Area 2" type="button"  
        onClick="ColdFusion.Layout.collapseArea('thelayout', 'left');">