SaveWorkspace Method (execution)

[This is preliminary documentation and is subject to change.]

Saves the Workspace of the current IPWindow.

Declaration Syntax

public static ExecutionResult SaveWorkspace(
	Execution execution
)

Parameters

execution (Execution): The Execution of the Save Workspace Operation which this is implementing.

Return Value

NoActionResult if the Workspace was not saved, or else an ExecutionResult with ResultAction.Commit and a confirmation message.

Remarks

The current IPWindow is the one that most recently had the focus. The Workspace is saved to the Workspaces collection of the Principal running the active Session.

This puts up a small dialogue box allowing the user to enter a name for the saved Workspace. If the entered name is already used in the Principal's Workspaces collection, then the user is asked for confirmation to overwrite the existing Workspace.

The workspace is saved along with details of the objects and/or collections displayed in each Pane, and the Layouts with which they are displayed. The RestoreWorkspace method will restore an IPwindow to exactly the same visual state as it was in when this method was called.

Assembly: Persistate (Module: Persistate) Version: 0.6.1.20 (0.6.1.20)