ColdFusion.MessageBox.update

Description

Updates the ColdFusion message box properties. This JavaScript function lets you update all the message box properties except name and type.

Function syntax

ColdFusion.MessageBox.update(name, configuration)

See also

ColdFusion.MessageBox.create, ColdFusion.MessageBox.getMessageBoxObject, ColdFusion.MessageBox.isMessageBoxDefined, ColdFusion.MessageBox.updateMessage, ColdFusion.MessageBox.updateTitle

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.

configuration

An object containing message box configuration parameters. For details, see “Usage”.

Returns

This function does not return a value.

Usage

This function is used to update a set of message box properties. For example, you can update the width, message, and title of the message box using the configuration parameter.

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

Entry

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

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

callbackhandler

The function that the control calls when a user clicks one of the buttons. For more information see Usage.

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

The text to put on the cancel button of a prompt message box.

labelok

The text to put on an alert button and prompt message box OK button.

labelno

The text to put on the button used for a negative response in a confirm message box.

labelyes

The text to put on the button used for a positive response in a confirm message box.

modal
A Boolean value that specifies if the message box is a modal window:

  • yes

  • no

message

The text to display inside the message box.

multiline

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.

title

The title for the message box. If you do not specify a title, ColdFusion assigns the control type value as the default title.

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 updates a message box.

<cfajaximport tags="cfmessagebox"> 
 
<cfform name="test"> 
    <cfinput type="button" name="x" value="Update Message Box"  
        onClick="ColdFusion.MessageBox.update('Messagebox1',  
        {width:400, modal:false, x:200, y:300, labelyes:'yes'})"> 
</cfform>