Skip to main content

Script Interfaces

Script Interfaces define the contracts between a script and the host. Each interface (IComponent, IEditTask, etc.) corresponds to a set of lifecycle callbacks the host invokes on the script. The minimum interface required depends on the script category.

Category Reference​

The category attribute in classfactory.xml determines which interface and lifecycle the script follows.

CategoryMinimum InterfacesLifecycle CallbacksPurpose
"EditTask"IEditTaskprepareEdit(), performEdit()Command/action script with optional dialog
"EditAddIn"IComponentinitialize(), terminate()Persistent add-in panel
"FrameworkService"IComponentinitialize(), terminate()Headless background service — auto-started at startup

See Interfaces - Callback Contracts for the full interface and callback contract reference.