showModalDialog Method

Creates a modal dialog box that displays the specified HTML document.

Syntax

vReturnValue = window.showModalDialog( sURL [ , vArguments ] [ , sFeatures ] )

Parameters

sURL

Required. String that specifies the URL of the document to load and display.

vArguments

Optional. Variant that specifies the arguments to use when displaying the document. Use this parameter to pass a value of any type, including an array of values. The dialog box can extract the values passed by the caller from the dialogArguments property of the window object.

sFeatures

Optional. String that specifies the window ornaments for the dialog box, using one or more of the following semicolon-delimited values:

dialogHeight:sHeight	Sets the height of the dialog window (see Remarks for default unit of measure).
dialogLeft:sXPos	Sets the left position of the dialog window relative to the upper-left corner of the desktop.
dialogTop:sYPos	Sets the top position of the dialog window relative to the upper-left corner of the desktop.
dialogWidth:sWidth	Sets the width of the dialog window (see Remarks for default unit of measure).
center:{ yes \| no \| 1 \| 0 \| on \| off }	Specifies whether to center the dialog window within the desktop. The default is yes .
dialogHide:{ yes \| no \| 1 \| 0 \| on \| off }	Specifies whether the dialog window is hidden when printing or using print preview. This feature is only available when a dialog box is opened from a trusted application. The default is no .
edge:{ sunken \| raised }	Specifies the edge style of the dialog window. The default is raised .
help:{ yes \| no \| 1 \| 0 \| on \| off }	Specifies whether the dialog window displays the context-sensitive Help icon. The default is yes .
resizable:{ yes \| no \| 1 \| 0 \| on \| off }	Specifies whether the dialog window has fixed dimensions. The default is no .
scroll:{ yes \| no \| 1 \| 0 \| on \| off }	Specifies whether the dialog window displays scrollbars. The default is yes .
status:{ yes \| no \| 1 \| 0 \| on \| off }	Specifies whether the dialog window displays a status bar. The default is yes for untrusted dialog windows and no for trusted dialog windows.
unadorned:{ yes \| no \| 1 \| 0 \| on \| off }	Specifies whether the dialog window displays the border window chrome. This feature is only available when a dialog box is opened from a trusted application. The default is no .

Return Value

Variant . Returns the value of the returnValue property as set by the window of the document specified in sURL .

Remarks

A modal dialog box retains the input focus while open. The user cannot switch windows until the dialog box is closed.

Because a modal dialog box can include a URL to a resource in a different domain, do not pass information through the vArguments parameter that the user might consider private. The vArguments parameter can be referenced within the modal dialog box using the dialogArguments property of the window object. If the vArguments parameter is defined as a string, the maximum string length that can be passed to the modal dialog box is 4096 characters; longer strings are truncated.

As of Microsoft® Internet Explorer 4.0, you can eliminate scroll bars on dialog boxes. To turn off the scroll bar, set the SCROLL attribute to false in the body element for the dialog window, or call the modal dialog box from a trusted application.

Internet Explorer 5 allows further control over modal dialog boxes through the status and resizable values in the sFeatures parameter of the showModalDialog method. Turn off the status bar by calling the dialog box from a trusted application, such as Microsoft Visual Basic® or an HTML Application (HTA), or from a trusted window, such as a trusted modal dialog box. These applications are considered to be trusted because they use Internet Explorer interfaces instead of the browser. Any dialog box generated from a trusted source has the status bar turned off by default. Resizing is turned off by default, but you can turn it on by specifying resizable=yes in the sFeatures string of the showModalDialog method.

You can set the default font settings the same way you set Cascading Style Sheets (CSS) attributes (for example, "font:3;font-size:4" ). To define multiple font values, use multiple font attributes.

The default unit of measure for dialogHeight and dialogWidth in Internet Explorer 4.0 is the pixel; in Internet Explorer 5 it is the em. The value can be an integer or floating-point number, followed by an absolute units designator ( cm , mm , in , pt , pc , or px ) or a relative units designator ( em or ex ). For consistent results, specify the dialogHeight and dialogWidth in pixels when designing modal dialog boxes.

Although a user can manually adjust the height of a dialog box to a smaller value —provided the dialog box is resizable —the minimum dialogHeight you can specify is 100 pixels.

To override center , even though the default for center is yes , you can specify either dialogLeft and/or dialogTop .

Examples

This example uses the showModalDialog method to open a customized dialog box.

<SCRIPT>
function fnRandom(iModifier)
{ return parseInt(Math.random()*iModifier); }
function fnSetValues()
{ var iHeight=oForm.oHeight.options[ oForm.oHeight.selectedIndex].text;
if(iHeight.indexOf("Random")>-1)
{ iHeight=fnRandom(document.body.clientHeight); }
var sFeatures="dialogHeight: " + iHeight + "px;"; return sFeatures; }
function fnOpen(){ var sFeatures=fnSetValues();
window. showModalDialog (" showModalDialog _target.htm", "", sFeatures) }
</SCRIPT>
<FORM NAME=oForm> Dialog Height <SELECT NAME="oHeight">
<OPTION>-- Random --
<OPTION>150 <OPTION>200 <OPTION>250 <OPTION>300
</SELECT> Create Modal Dialog Box
<INPUT TYPE="button" VALUE="Push To Create" onclick="fnOpen()">
</FORM>

Standards Information

There is no public standard that applies to this method.

Applies To

Platform Version

Win16:
Win32:
Windows CE:
Unix:
Mac:

window

Home | Top | Website design | JavaScript Editor

Get Advanced
JavaScript and Ajax Editor,
Validator and Debugger!
1st JavaScript Editor.

→