Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDialogOptions

Dialog Options

Hierarchy

  • IDialogOptions

Index

Properties

Properties

Optional allowMaximize

allowMaximize: boolean

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

Optional args

args: any

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

Optional autoSize

autoSize: boolean

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

Optional dialogReturnValueCallback

dialogReturnValueCallback: (dialogResult?: number, returnVal?: any) => void

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.

Type declaration

    • (dialogResult?: number, returnVal?: any): void

    • Parameters

      • Optional dialogResult: number
      • Optional returnVal: any

      Returns void

Optional height

height: number

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

Optional html

html: Element

An html element to display in the dialog. If both html and url are specified, url takes precedence. Either url or html must be specified.

Optional showClose

showClose: boolean

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

Optional showMaximized

showMaximized: boolean

A Boolean value that specifies whether the dialog opens in a maximized state. true 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.

Optional title

title: string

A string that contains the title of the dialog.

Optional url

url: string

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.

Optional width

width: number

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 width of the dialog is set to 768 pixels.

Optional x

x: number

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

Optional y

y: number

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

Generated using TypeDoc