Skip to main content

IApplication Interface

Namespace: NextDesign.Desktop

Description

This is a shared variable provided to the extension execution environment.
Scripts can access various application information through this variable.

Area

NameDescription
GlobalThis is a set of APIs for accessing the extension's execution environment and execution state.

Property

NameDescription
CommandsCommand Manager
CustomUIThis is the registry for the user interface of the custom extension.
EditionIdEdition Identifier Name
EditionShortNameEdition Short Name
EnvApplication Execution Environment
ErrorsError List
ExtensionsExtension Management
FileUtilFile Operation Utility Object
OutputOutput
ResourcesResource Manipulation Utility
SearchSearch Manager
UtilGeneral Purpose Utility Object
VersionApplication Version Number
WindowWorkspace Window UI Manipulation Object
WorkspaceWorkspace

Method

NameDescription
CreateCommandParamsCreates command parameters.
CreateScriptParamsCreates script parameters.
CreateSearch[Obsolete] Creates a search object.
ExecuteCommandExecutes the command with the specified identifier.
ExecuteScriptReads and executes the specified script file.

Identifies the scripting language from the extension of the specified script file.
- ".cs" or ".csx": Executes as a CSharp script.
- ".py": Executes as a Python script.

In V5.0, an exception is thrown if a file with an extension other than those listed above is specified.
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, the path of the project file will be used as the starting point for searching for external files, provided that the currently open project is saved.
GetFeatureValueRetrieves the specified key (attribute) value of the specified feature in the current edition.
The value can be retrieved regardless of whether the specified feature is enabled or disabled.

If the specified feature is not found, the value will be null.
Also, if the specified feature key name is not found, the value will be null.
IsFeatureEnabledChecks if the specified feature is enabled in the current edition.
QuitExits the application.
RestartRequests the application to restart.
If the project was open when the restart was requested, the same project will be opened after the restart.
If the restart fails, it returns false.
ThrowUserExceptionThrows a user exception.
This method can be used when you want to explicitly notify an exception in the runtime exception handling of the extension.
NameDescription
Shared VariablesShared variables provided to the extension execution environment.
Scripts can access various information about the application through these variables.