Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OperationDialog

Represents an operation dialog.

Hierarchy

  • OperationDialog

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

params

params: OperationDialogOptions

Dialog parameters.

wnd

wnd: StandardWindow

Underlying dialog window.

Methods

close

  • close(): void

  • Closes the dialog.

    Returns void

copy

  • copy(src: string[], dest: string): Promise<void>

  • Shows a copy operation dialog.

    Parameters

    • src: string[]

      An array of sources to copy.

    • dest: string

      The destination folder.

    Returns Promise<void>

delete

  • delete(src: string[], type?: "normal" | "trash"): Promise<void>

  • Shows an item deletion dialog.

    Parameters

    • src: string[]

      An array of sources to delete.

    • Optional type: "normal" | "trash"

      The type of deletion.

    Returns Promise<void>

emptyBin

  • emptyBin(): Promise<void>

  • [Not implemented] Empties the recycle bin.

    Returns Promise<void>

move

  • move(src: string[], dest: string): Promise<void>

  • Shows a move operation dialog.

    Parameters

    • src: string[]

      An array of sources to ,pve.

    • dest: string

      The destination folder.

    Returns Promise<void>

recycle

  • recycle(src: string[]): Promise<void>

  • Shows a recycling operation dialog.

    Parameters

    • src: string[]

      An array of sources to recycle.

    Returns Promise<void>

setProgress

  • setProgress(percentage: number): void

  • Sets the window progress.

    Parameters

    • percentage: number

      The percentage to set.

    Returns void

setStatusText

  • setStatusText(text: string): void

  • Sets the status text.

    Parameters

    • text: string

      The text to use.

    Returns void

show

  • show(): void

  • Shows the dialog.

    Returns void

wait

  • wait(): Promise<void>

  • Waits for the dialog to complete.

    Returns Promise<void>

Generated using TypeDoc