ColdFusion.Window.onShow

Description

Specifies a function to run each time a specific window shows, including when you create a window and specify an initShow attribute or configuration entry value of true.

Function syntax

ColdFusion.Window.onShow(windowName, handler)

See also

cfwindow, ColdFusion.Window.create, ColdFusion.Window.getWindowObject, ColdFusion.Window.hide, ColdFusion.Window.onHide, ColdFusion.Window.show, ColdFusion.Tree.getTreeObject, Using pop-up windows in the Developing ColdFusion Applications

History

ColdFusion 8: Added this function

Parameters

Parameter

Description

windowName

The name of the window. The handler function runs whenever this window shows.

handler

The JavaScript function to run when the window shows.

Returns

This function does not return a value.

Usage

The function specified in the handler parameter can optionally take one parameter, which contains the window name.

One use for this function is to fetch window data only when the window shows. You could use a cfajaxproxy tag to create a JavaScript proxy for a CFC function that provides the data, and then a ColdFusion.Window.onShow function to specify a function that calls the proxy function and updates the window contents with the new data.

Example

The following example uses the ColdFusion.Window.onShow function to display an alert with information about the window when you click a button that shows the window:

<html xmlns="http://www.w3.org/1999/xhtml"> 
<head> 
    <script language="javascript"> 
        function onshow(name) { 
            alert("window shown = " + name); 
        } 
 
        function test() { 
            ColdFusion.Window.onShow("testWindow", onshow); 
            ColdFusion.Window.show("testWindow"); 
        } 
    </script> 
</head> 
<body> 
 
<cfwindow name="testWindow" initshow=false title="test window" 
    closable=true> 
    Window contents 
</cfwindow> 
 
<cfform> 
    <cfinput name="button" value="show Window" onclick="javascript:test()" type="button"/> 
</cfform> 
</body> 
</html>