Class ModalDialog

Represents a modal dialog

Hierarchy

Index

Properties

Methods

Properties

public static get_childDialog: any

Methods

public static OpenPopUpPage(url: string, callback: DialogReturnValueCallback, width: number, height: number)

Show modal dialog specified by url, callback, height and width.

Parameters

public static RefreshPage(dialogResult: DialogResult)

Refresh the page if specified dialogResult equals to SP.UI.DialogResult.OK

Parameters

public static ShowPopupDialog(url: string)

Show page specified by the url in a modal dialog. If the dialog returns SP.UI.DialogResult.OK, the page is refreshed.

Parameters

  • url: string

public autoSize()

public autoSizeSuppressScrollbar(resizePageCallBack: any)

Parameters

  • resizePageCallBack: any

public close(dialogResult: DialogResult)

Closes the dialog using the specified dialog result.

Parameters

public static commonModalDialogClose(dialogResult: DialogResult, returnValue: any)

Should be called from an existing dialog.

Parameters

public static commonModalDialogOpen(url: string, options: IDialogOptions, callback: DialogReturnValueCallback, args: any)

Shows a modal dialog, specified by url, callback, args, and options. Internally, uses SP.UI.ModalDialog.showModalDialog.

Parameters

public get_allowMaximize(): boolean

Returns

boolean

public get_args(): any

Returns

any

public get_closed(): boolean

Returns

boolean

public get_dialogElement(): HTMLElement

Returns

HTMLElement

public get_firstTabStop(): HTMLElement

Returns

HTMLElement

public get_frameElement(): HTMLFrameElement

Returns

HTMLFrameElement

public get_html(): string

Returns

string

public get_isMaximized(): boolean

Returns

boolean

public get_lastTabStop(): HTMLElement

Returns

HTMLElement

public get_returnValue(): any

Returns

any

public get_showClose(): boolean

Returns

boolean

public get_title(): string

Returns

string

public get_url(): string

Returns

string

public set_returnValue(value: any)

Parameters

  • value: any

public static showModalDialog(options: IDialogOptions): ModalDialog

Displays a modal dialog defined by the specified options.

Parameters

Returns

ModalDialog

public static showPlatformFirstRunDialog(url: string, callbackFunc: DialogReturnValueCallback): ModalDialog

Parameters

Returns

ModalDialog

public static showWaitScreenSize(title: string, message: string, callbackFunc: DialogReturnValueCallback, height: number, width: number): ModalDialog

Displays a wait/loading modal dialog with the specified title, message, height and width. Height and width are defined in pixels. Cancel button is shown. If user clicks it, the callbackFunc is called.

Parameters

Returns

ModalDialog

public static showWaitScreenWithNoClose(title: string, message: string, height: number, width: number): ModalDialog

Displays a wait/loading modal dialog with the specified title, message, height and width. Height and width are defined in pixels. Cancel/close button is not shown.

Parameters

  • title: string
  • message: string
  • height: number
  • width: number

Returns

ModalDialog