User Guide Cancel

cfmessagebox

Last updated on May 30, 2024 | Also applies to ColdFusion

CFML Reference User Guide
ColdFusion functions
ColdFusion Tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

Description

Defines a control for displaying pop-up messages. The control has more features than the standard alert box, including the ability to include a prompt and entry field in the box.

Syntax

<cfmessagebox 
bodyStyle = "CSS style specification" 
buttonType = "yesno|yesnocancel" 
callbackHandler = "function name" 
icon = "error|info|question|warning" 
labelCancel = "Cancel button label text" 
labelNo = "No button label text" 
labelOk = "OK button label text" 
labelYes= "Yes button label text" 
message = "message text" 
modal = "yes|no" 
multiline = "false|true" 
name = "control name" 
title = "title" 
type = "alert|confirm|prompt" 
width = "number of pixels" 
x = "numeic pixel coordinate" 
y = "numeic pixel coordinate"/>

History

ColdFusion 9: Added this tag

Attributes

Attribute	Req/Opt	Default	Description
bodyStyle	Optional		A CSS style specification for the body of the message box. As a general rule, use this attribute to set color and font styles.
buttonType	Optional	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
callbackhandler	Optional		The function that the control calls when a user clicks one of the buttons. For more information see Usage.
icon	Optional		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	Optional	Cancel	The text to put on the cancel button of a prompt message box.
labelOk	Optional	OK	The text to put on an alert button and prompt message box OK button.
labelNo	Optional	No	The text to put on the button used for a negative response in a confirm message box.
labelYes	Optional	Yes	The text to put on the button used for a positive response in a confirm message box.
message	Optional		The text to display inside the message box.
modal	Optional	yes	A Boolean value that specifies if the message box must be a modal window: yes no
multiline	Optional	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.
name	Required		The control name. Used to refer to the control in JavaScript.
title	Optional		The title for the message box. If you do not specify a title, ColdFusion assigns the control type value as the default title.
type	Required		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.
width	Optional		Width of the message box in pixels.
x	Optional		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	Optional		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.

Usage

The cfmessagebox creates a message box, but does not show it. You show a message box, say named mymessagebox, in JavaScript code as follows:

ColdFusion.MessageBox.show("mymessagebox");

If you specify a callbackhandler, clicking a button in the message box invokes the callbackhandler by passing the button label as a parameter. For prompt boxes, an additional parameter containing the prompt text is also passed.

For alert and confirm boxes:

var function_name = function(button);

For prompt boxes:

var function_name = function(button, promptmessage);

The EventObject parameter is the JavaScript ID (not the name) of the button that was pressed. The textmessage parameter is a string with the contents of the prompt text box.

Example

The following example has three buttons, one to display each type of message box. The message box labels are customized, and the messagebox callback function displays the type of the clicked button.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
<html xmlns="http://www.w3.org/1999/xhtml"> 
<head> 
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
<title>Untitled Document</title> 

<script type="text/javascript"> 
//Function to to show result of a message box. 
var showResult1 = function(btn,message){ 
alert("You entered: "+message); 
} 
//Function to show results of other message boxes. 
var showResult2 = function(btn){ 
alert("You clicked button: "+btn); 
} 

//The button onClick handler displays the message boxes. 
function showMB(mbox) { 
ColdFusion.MessageBox.show(mbox); 
} 
</script> 
</head> 

<body> 
<cfform> 
<p>Click a button display the corresponding message box.</p> 
<cfinput name="Prompt" type="button" value="Prompt" 
onclick="showMB('mymessagebox01')"> 
<cfinput name="Prompt" type="button" value="Prompt" 
onclick="showMB('mymessagebox02')"> 
<cfinput name="Prompt" type="button" value="Prompt" 
onclick="showMB('mymessagebox03')"> 
</cfform> 

<!--- Code to define the message boxes. ---> 
<cfmessagebox name="mymessagebox01" type="prompt" 
message="Write a short description about yourself" 
labelOK="This is OK" labelCANCEL="Cancel this" 
callbackhandler="showResult1" multiline="true"/> 

<cfmessagebox name="mymessagebox02" type="confirm" 
message="Is it OK to save the planet?" 
labelNO="Dont Save" labelYES="Sure" 
callbackhandler="showResult2"/> 

<cfmessagebox name="mymessagebox03" type="alert" 
message="You have been ALERTED!" 
callbackhandler="showResult2" /> 

</body> 
</html>

Get help faster and easier

New user?