AboutSupportDeveloper GuideVersion 22.3.24

Interface ApplyWorkspaceOptions

Options for the applyWorkspace method.

interface ApplyWorkspaceOptions {
    applySnapshotOptions?: ApplySnapshotOptions;
    promptContainerWindowIdentity?: Identity_4;
    shouldCenterModalOnMonitor?: boolean;
    skipPrompt?: boolean;
}

Properties

applySnapshotOptions? promptContainerWindowIdentity? shouldCenterModalOnMonitor? skipPrompt?

Properties

OptionalapplySnapshotOptions

applySnapshotOptions?: ApplySnapshotOptions

Options to apply the workspace snapshot with.

OptionalpromptContainerWindowIdentity

promptContainerWindowIdentity?: Identity_4

The window to use as the parent for the workspace switch confirmation dialog.

OptionalshouldCenterModalOnMonitor

shouldCenterModalOnMonitor?: boolean

Should the dialog modal be centered on the monitor instead of on top of the platform window

OptionalskipPrompt

skipPrompt?: boolean

If true, the workspace will be applied without prompting the user to confirm. If false, the user will be prompted to confirm the workspace application.

Default

false

Settings

On This Page

Properties