SP.UI.ModalDialog.commonModalDialogOpen(url, options, callback, args) Method

SharePoint 2010

Last modified: May 23, 2011

Applies to: SharePoint Foundation 2010

Displays a modal dialog with the specified URL, options, callback function, and arguments.

SP.UI.ModalDialog.commonModalDialogOpen(url, options, callback, args);

url

Type: String

The URL of the page to be shown in the modal dialog.

options

Type: Object

The options to create the modal dialog.

callback

Type: function pointer

The callback function that runs when the modal dialog is closed.

args

Type: Object

The arguments to the modal dialog.

The following table lists the available dialog options. To set an option, set the indicated property of the options parameter. All of these options are optional. However, either the url or html option is required.

options Property

Description

title

A string that contains the title of the dialog.

url

A string that contains the URL of the page that appears in the dialog. If both url and html are specified, url takes precedence. Either url or html must be specified.

html

A string that contains the HTML of the page that appears in the dialog. If both html and url are specified, url takes precedence. Either url or html must be specified.

x

An integer value that specifies the x-offset of the dialog. This value works like the CSS left value.

y

An integer value that specifies the y-offset of the dialog. This value works like the CSS top value.

width

An integer value that specifies the width of the dialog. If width is not specified, the width of the dialog is autosized by default. If autosize is false, the dialog width is set to 768 pixels.

height

An integer value that specifies the height of the dialog. If height is not specified, the height of the dialog is auto-sized by default. If autosize is false, the dialog height is set to 576 pixels.

allowMaximize

A Boolean value that specifies whether the dialog can be maximized. true the Maximize button is shown; otherwise, false.

showMaximized

A Boolean value that specifies whether the dialog opens in a maximized state. True if the dialog opens maximized. Otherwise, the dialog is opened at the requested sized if specified; otherwise, the default size, if specified; otherwise, the autosized size.

showClose

A Boolean value that specifies whether the Close button appears on the dialog.

autoSize

A Boolean value that specifies whether the dialog platform handles dialog sizing.

dialogReturnValueCallback

A function pointer that specifies the return callback function. The function takes two parameters, a dialogResult of type SP.UI.DialogResult Enumeration and a returnValue of type object that contains any data returned by the dialog.

args

An object that contains data that are passed to the dialog.

The url, callback, and args parameters of this method override the matching arguments in the options parameter.

Show:
© 2014 Microsoft