IWorkspace interface

Namespace: NextDesign.Desktop

Description

Provides access to application workspace information.

Area you belong to

Name	Description
Workspace Project	This is a group of APIs that access the application's work area and the projects open in the application.

Property

Name	Description
CurrentEditor	Editor information currently displayed in the currently selected editor view Returns null if the editor is not displayed.
CurrentModel	Selected model element in current project Returns null if no model is selected.
CurrentProduct	Product currently applied in the current project
CurrentProject	Current Project Returns information about the project currently open in the application's workspace. Returns null if no project is open in the application.
Errors	Error list Use this object to access the currently registered error information.
InfoDisplayStyleSet	Definition of style set This object allows you to manage the styles that can be specified when displaying errors and search results.
MainEditor	Information about the editor currently displayed in the main editor view Returns null if the editor is not displayed.
Output	Output You can use this object to access the output of your application.
ProjectAutoReload	Whether to reload the project Gets whether to automatically reload the project when changes are made to the project outside of Next Design, or Set. If the project is automatically reloaded, a confirmation dialog will be displayed. Specify true to reload the project, false to not reload.
Scm	Configuration management access object
Search	Search This object allows you to access a list of search results.
State	Workspace state
SubEditor	Information about the editor being displayed in the current subeditor view Returns null if the editor is not being displayed.

Method

Name	Description
CanRedo	Checks whether an undone editing operation can be re-executed.
CanUndo	Checks if an editing operation can be undone.
CleanUpProject	Cleans up the specified project. If no project is specified, cleans the current project currently open in the application. Project cleanup processing is performed only on editable units among the managed units of the specified project. If the target project has not been saved, calling this method will fail.
CloseDiff	End the difference comparison.
CloseProject	Closes the specified project. If no project is specified, closes the current project currently open in the application. This call silently discards changes and closes the project, even if the target project has not been saved.
CreateSearch	[Obsolete] Generates a search object. Using this object, you can start and end a search and register search results.
GenerateDocument	Generate the document. Set the selected element in the model navigator as the base model for output.
GetModelUnitByLoadMode	Gets the model unit that is set to the specified load mode.
LoadModelUnits(IProject,IEnumerable<IModelUnit>)	Add the specified model unit in the specified project Load. If the specified unit has already been loaded or is not managed by the specified project, it will be ignored. If the target project is the current project, a busy indicator will be displayed and the project will be executed. However, cancellation is not possible. If the target project has not been saved, calling this method will fail. If the target project is the current project, a message dialog will be displayed on ND and additional loading will be interrupted, just as when executed from the project navigator. An exception will occur if the project is not the current project.
LoadModelUnits(IProject,IEnumerable<string>)	Add the specified model unit in the specified project Load. If the specified unit has already been loaded or is not managed by the specified project, it will be ignored. If the target project is the current project, a busy indicator will be displayed and the project will be executed. However, cancellation is not possible. If the target project has not been saved, calling this method will fail. If the target project is the current project, a message dialog will be displayed on ND and additional loading will be interrupted, just as when executed from the project navigator. An exception will occur if the project is not the current project.
NewProject	Create a new project.
OpenDiff	Displays a difference comparison based on the specified difference comparison information.
OpenProject(string,bool,bool)	Opens the specified project.
OpenProject(string,OpenProjectOptions)	Opens the project with the specified options applied.
Redo	Redos an undone edit operation.
ReloadProject	Reloads the specified project. If no project is specified, the current project currently open in the application will be reloaded.
SaveAll	Resave the file based on the latest state. If no project is specified, save the current project. Throws an exception if no file has been created for the specified project. Unloaded units and read-only units are not saved.
SaveProject	Saves the specified project. If no project is specified, the current project currently open in the application will be saved. Returns True if the save was successful. If you use this method in situations where file access rights cannot be obtained or there is insufficient free space, the project will not be saved and this method will return False. The save destination of the project is the path that can be obtained with IProject.Path. Therefore, this method cannot be executed for a new project that has never been saved. When saving a new project, please use SaveProjectAs().
SaveProjectAs	Saves the specified project at the specified path. If no project is specified, the current project currently open in the application will be saved. Returns True if the save was successful. This call will silently overwrite if a file already exists at the specified path. If the save is successful, the target project's Path will be replaced with the new path.
SetLoadMode	Sets the model unit load mode. Ignored if the specified unit is not managed by the specified project.
Undo	Undoes an editing operation.