Adobe ColdFusion 8

ColdFusion.Layout.hideArea

Description

Hides an area of a border layout.

Function syntax

ColdFusion.Layout.hideArea(layout, layoutArea)

See also

cflayout, cflayoutarea, ColdFusion.Layout.collapseArea, ColdFusion.Layout.expandArea, ColdFusion.Layout.showArea, "Using layouts" in the ColdFusion Developer's Guide

History

ColdFusion 8: Added this function

Parameters

Parameter

Description
layout

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

The position in the layout of the area to hide. 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 hidden.

Example

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

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