ColdFusion.MessageBox.create

Description

Creates a ColdFusion message box. This function is equivalent to the cfmessagebox tag.

Function syntax

ColdFusion.MessageBox.create(name, type, title, message, callbackhandler [, configuration])

History

ColdFusion 9: Added this function

Parameters

Parameter	Description
name	The name of the message box. This attribute is required to show and update the message box. The message box name must be unique on the page.
type	The control type. Must be one of the following: alert - A message with a single OK button. confirm - A message box with two buttons YES and NO or three buttons YES, NO, and CANCEL. prompt - A message box with a single-line or multiline text input area and OK and CANCEL buttons.
title	The text to display on the message box title bar.
message	The text to display inside the message box.
callbackhandler	The function that the control calls when a user clicks one of the buttons.
configuration	An object containing message box configuration parameters. For details, see "Usage".

Returns

This function does not return a value.

Usage

This function is equivalent to the cfmessagebox tag. If you do not also use a cfmessagebox tag on a page that calls this function, specify a cfajaximport tag on the page and specify cfmessagebox in the tags attribute. Doing so ensures that the page includes the necessary JavaScript to create the message box. For example, use the following line if you do not have to import the JavaScript for any other ColdFusion Ajax features:

The configuration parameter defines the message box characteristics; it can have any or all the following entries:

Entry	Default	Description
bodystyle		A CSS style specification for the body of the message box. Generally, you use this attribute to set color and font styles.
buttontype	yesno	Applies to the control type - confirm.The buttons to display on the message box: yesno: displays the buttons Yes and No yesnocancel: displays the buttons Yes, No, and Cancel *
icon		Specifies the following CSS classes: error: Provides the error icon. You can use this icon when displaying error messages. info: Provides the info icon. You can use this icon when displaying any information. question: Provides the question icon. You can use this icon in a confirmation message box that prompts a user response. warning: Provides the warning icon. You can use this icon when displaying a warning message.
labelcancel	Cancel	The text to put on the cancel button of a prompt message box.
labelok	OK	The text to put on an alert button and prompt message box OK button.
labelno	No	The text to put on the button used for a negative response in a confirm message box.
labelyes	Yes	The text to put on the button used for a positive response a confirm message box.
modal	yes	A Boolean value that specifies if the message box is a modal window: yes no
multiline	false	Valid only for prompt type message boxes. A Boolean value specifying whether the prompt input text box has a single or multiple lines for text input.
width		Width of the message box in pixels.
x		The X (horizontal) coordinate of the upper-left corner of the message box.ColdFusion ignores this attribute if you do not set the y attribute.
y		The Y (vertical) coordinate of the upper-left corner of the message box.ColdFusion ignores this attribute if you do not set the x attribute.

Note: Entry names in the configuration object must be all-lowercase.

Example

The following minimal CFML application creates a message box of type confirmation.

<cfajaximport tags="cfmessagebox">

<cfform name="test">
<cfinput type="button" name="x" value="Create Message Box"
onClick="ColdFusion.MessageBox.create('Messagebox1', 'confirm','Confirm',
'Do you want to save the file?',
onfinish, {width:200, modal:false})">
</cfform>
<script language="JavaScript" type="text/javascript">
function onfinish()
{
alert('Button clicked');
};
</script>