Class WorkspaceFrontendContribution

Protected ReadonlycontextKeyService

Protected ReadonlyencodingRegistry

Protected ReadonlyfileDialogService

Protected ReadonlyfileService

Protected ReadonlymessageService

Protected ReadonlyopenerService

Protected ReadonlypreferenceConfigurations

Protected ReadonlyquickOpenWorkspace

Protected ReadonlysaveService

Protected ReadonlytoDisposeOnUpdateEncodingOverrides

Protected ReadonlyworkspaceFileService

Protected ReadonlyworkspaceService

ProtectedcloseWorkspace

• closeWorkspace(): Promise<void>

  Returns Promise<void>

ProtectedcreateMultiRootWorkspace

• createMultiRootWorkspace(roots: FileStat[]): Promise<URI>

  Parameters

  • roots: FileStat[]

  Returns Promise<URI>

ProtecteddoOpen

• doOpen(): Promise<undefined | URI[]>

  This is the generic Open method. Opens files and directories too. Resolves to the opened URI. Except when you are on either Windows or Linux AND running in electron. If so, it opens a file.

  Returns Promise<undefined | URI[]>

ProtecteddoOpenFile

• doOpenFile(): Promise<undefined | URI[]>

  Opens a set of files after prompting the Open File dialog. Resolves to undefined, if

  • the workspace root is not set,
  • the file to open does not exist, or
  • it was not a file, but a directory.

  Otherwise, resolves to the set of URIs of the files.

  Returns Promise<undefined | URI[]>

ProtecteddoOpenFolder

• doOpenFolder(): Promise<undefined | URI>

  Opens one or more folders after prompting the Open Folder dialog. Resolves to undefined, if

  • the user's selection is empty or contains only files.
  • the new workspace is equal to the old workspace.

  Otherwise, resolves to the URI of the new workspace:

  • a single folder if a single folder was selected.
  • a new, untitled workspace file if multiple folders were selected.

  Returns Promise<undefined | URI>

ProtecteddoOpenWorkspace

• doOpenWorkspace(): Promise<undefined | URI>

  Opens a workspace after raising the Open Workspace dialog. Resolves to the URI of the recently opened workspace, if it was successful. Otherwise, resolves to undefined.

  Returns Promise<undefined | URI>

ProtecteddoUpdateState

• doUpdateState(): "empty" | "workspace" | "folder"

  Returns "empty" | "workspace" | "folder"

ProtectedgetOpenableWorkspaceUri

• getOpenableWorkspaceUri(uris: MaybeArray<URI>): Promise<undefined | URI>

  Parameters

  • uris: MaybeArray<URI>

  Returns Promise<undefined | URI>

ProtectedgetWorkspaceDialogFileFilters

• getWorkspaceDialogFileFilters(): FileDialogTreeFilters

  Returns FileDialogTreeFilters

ProtectedsaveWorkspaceAs

• saveWorkspaceAs(): Promise<boolean>

  Returns Promise<boolean>

  whether the file was successfully saved.

ProtectedupdateEncodingOverrides

• updateEncodingOverrides(): void

  Returns void

ProtectedupdateStyles

• updateStyles(): void

  Returns void

ProtectedupdateWorkbenchStateKey

• updateWorkbenchStateKey(): "empty" | "workspace" | "folder"

  Returns "empty" | "workspace" | "folder"

ProtectedupdateWorkspaceStateKey

• updateWorkspaceStateKey(): "empty" | "workspace" | "folder"

  Returns "empty" | "workspace" | "folder"