Skip to main content

IApplication interface

Namespace: NextDesign.Desktop

Description

Shared variables given to the extension execution environment.
Scripts can access various information about the application through these variables.

Belonging area

NameDescription
GlobalA group of APIs to access the extension execution environment and execution status.

Property

NameDescription
CommandsCommand manager
CustomUIA registry for custom user interface extensions.
DiffDifference extraction object
EditionIdEdition identification name
EditionShortNameEdition short name
EnvApplication execution environment
ErrorsError list
ExtensionsExtension management
FileUtilFile operation utility object
OutputOutput
ResourcesResource manipulation utilities
Search](properties/Search.md)Search manager
Util](properties/Util.md)General utility objects
Version](properties/Version.md)Application version number
Window](properties/Window.md)Workspace window UI manipulation objects
Workspace](properties/Workspace.md)Workspace

Method

NameDescription
CreateCommandParams](methods/CreateCommandParams.md)Create command parameters.
CreateScriptParams](methods/CreateScriptParams.md)Create script parameters.
CreateSearch[Obsolete] Creates a search object.
ExecuteCommandExecutes a command with the specified identifier.
ExecuteScriptLoads and executes the specified script file.
ExecuteScriptCode(string,string,IScriptParams)Executes the given script code.
ExecuteScriptCode(string,string,string,IScriptParams)Executes the given script code.

By specifying basePath, you can use relative paths for external files used in the script code.
If not specified, and the currently open project has been saved, the path of the project file is used as the starting point for searching for external files.
GetFeatureValueGets the specified key (attribute) value of the specified feature in the current edition.
The value can be obtained regardless of whether the specified feature is enabled or disabled.

Note that if the specified feature is not found, the value returns null.
Also, if the specified feature key name is not found, the value returns null.
IsFeatureEnabledChecks whether the specified feature is enabled in the current edition.
QuitExits the application.
RestartRequests the application to be restarted.
If a project is open when the restart is requested, the same project will be opened after the restart.
If the restart fails, false will be returned.
ThrowUserExceptionThrows a user exception.
This method can be used to explicitly notify an exception during the extension's runtime exception handling.
NameDescription
Shared variablesShared variables given to the extension execution environment.
The script can access various information about the application through this variable.