Tag: Interface

Definition of the user interface.

Tree

<extension>

<interface>
<interface/>

<callbacks> ... </callbacks>
<images>
<toolbar>

</interface>

</extension>

Remarks

This interface element information pertains specifically to the GUI.

Mandatory Attributes

Name	Description	Type	Allowed Values
context	Context or combination of contexts (separated using '\|') for the interface.	String[]

Optional Attributes

Name	Description	Type	Default Value	Allowed Values
engineType	Allows user to specify what scripting engine to use for the extensions. It defaults to IronPython but can be switched to CPython.	String	IronPython	IronPython, CPython
propertyEvents	Specifies when property events should be invoked. This could be set to 'UI,' which means that property events are only invoked when changing properties from the UI. When set to 'All,' property events are invoked when properties are changed from UI and via scripting. Event firing is directly associated with the state an application may end up. For example, if propertyEvents was set to 'UI,' and a property is changed via script, the application may not be in the correct/expected state after the property change is complete.	String	UI	UI, All

Callbacks

Name	Description
OnActiveObjectChange(IDataModelObject, ObjectLocationEnum)	Called when the active object change.
OnInit(String)	Called when the given context is initialized.
OnTerminate(String)	Called when the given context is terminated.
OnUnitsChanged()	OnUnitsChanged. Called when the unit system changes.
Resume(BinaryReader)	Called when a project is loaded. Usefull to retreive aditional data.
Save(BinaryWriter)	Called when a project is saved. Usefull to save aditional data.