Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IModalDialog

cateogry

Modal Dialog

Hierarchy

  • IModalDialog

Index

Methods

Methods

OpenPopUpPage

  • OpenPopUpPage(url: string, callback?: (dialogResult?: number, returnVal?: any) => void, width?: number, height?: number): any

  • Displays a modal dialog with the specified URL, callback function, width, and height.

    Parameters

    • url: string

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

    • Optional callback: (dialogResult?: number, returnVal?: any) => void

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

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

        • Parameters

          • Optional dialogResult: number
          • Optional returnVal: any

          Returns void

    • Optional width: number

      The width of the modal dialog.

    • Optional height: number

      The height of the modal dialog.

    Returns any

RefreshPage

  • RefreshPage(dialogResult?: number): any

  • Refreshes the parent page of the modal dialog when the dialog is closed by clicking OK.

    Parameters

    • Optional dialogResult: number

      The result of the modal dialog.

    Returns any

ShowPopupDialog

  • ShowPopupDialog(url: string): any

  • Displays a modal dialog using the page at the specified URL.

    Parameters

    • url: string

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

    Returns any

commonModalDialogClose

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

  • Closes the most recently opened modal dialog with the specified dialog result and return value.

    Parameters

    • Optional dialogResult: number

      One of the enumeration values that specifies the result of the modal dialog.

    • Optional returnVal: any

      The return value of the modal dialog.

    Returns any

commonModalDialogOpen

  • commonModalDialogOpen(url: string, options?: IDialogOptions, callback?: (dialogResult?: number, returnVal?: any) => void, args?: any): any

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

    Parameters

    • url: string

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

    • Optional options: IDialogOptions

      The options to create the modal dialog.

    • Optional callback: (dialogResult?: number, returnVal?: any) => void

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

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

        • Parameters

          • Optional dialogResult: number
          • Optional returnVal: any

          Returns void

    • Optional args: any

      The arguments to the modal dialog.

    Returns any

load

  • load(): PromiseLike<void>

  • Method to ensure the core script is loaded

    Returns PromiseLike<void>

showModalDialog

  • Displays a modal dialog with specified dialog options.

    Parameters

    Returns PromiseLike<IModalDialogObj>

showWaitScreenSize

  • showWaitScreenSize(title: string, message?: string, callback?: () => void, height?: number, width?: number): PromiseLike<IModalDialogObj>

  • Displays a wait screen dialog that has a Cancel button using the specified parameters.

    Parameters

    • title: string

      The title of the wait screen dialog.

    • Optional message: string

      The message that is shown in the wait screen dialog.

    • Optional callback: () => void

      The callback function that runs when the wait screen dialog is closed.

        • (): void

        • Returns void

    • Optional height: number

      The height of the wait screen dialog.

    • Optional width: number

      The width of the wait screen dialog.

    Returns PromiseLike<IModalDialogObj>

showWaitScreenWithNoClose

  • showWaitScreenWithNoClose(title: string, message?: string, height?: number, width?: number): PromiseLike<IModalDialogObj>

  • Displays a wait screen dialog that does not have a Cancel button using the specified parameters.

    Parameters

    • title: string

      The title of the wait screen dialog.

    • Optional message: string

      The message that is shown in the wait screen dialog.

    • Optional height: number

      The height of the wait screen dialog.

    • Optional width: number

      The width of the wait screen dialog.

    Returns PromiseLike<IModalDialogObj>

Generated using TypeDoc