<Interface>

Defines the user interface for the extension.

<extension version="[version id (integer)]"   
           name="[extension name (string)]"               
  <interface context="[Project | Mechanical]">   
   ...
  </interface>

Sub-element tags for the <Interface> element

<Callbacks>

Specifies the callbacks that invoke functions from the IronPython extension script.

<filter>

Defines a filter.

<images>

Defines the default folder where images to be used by the extension are stored.

<images>[folder]</images>

<toolbar>

Defines a toolbar.

 <toolbar name="[toolbar internal name (string)]" caption="[toolbar display name (string)]">
    <entry>...</entry>
 </toolbar>

Attributes for the <Interface> element

context

Context or combination of contexts (separated using '|') for the interface.

Mandatory.

context="[context name]”

Callbacks for the <Interface> element

<GetPostCommands>

Called to collect all "post" commands to add to the solver input file.

<getpostcommands>[function(analysis,stream)]</getpostcommands>

<GetPreCommands>

Called to collect all "pre" commands to add to the solver input file.

<getprecommands>[function(analysis,stream)]</getprecommands>

<GetSolveCommands>

Called to collect all "solve" commands to add to the solver input file.

<getsolvecommands timedependent="[true | false(default)]">

<IsAnalysisValid>

Called to check if an analysis is valid.

<isanalysisvalid>[function(solver)]</isanalysisvalid>

<OnActiveObjectChange>

Called when the active object is changed.

<OnAfterGeometryUpdate>

Called after the geometry has been updated.

<OnAfterRemove>

Called after the object has been removed.

<OnAfterSolve>

Called after an analysis has been solved.

<onaftersolve>[function(analysis)]</onaftersolve>

<OnBeforeGeometryUpdate>

Called before the geometry is starts to update.

<OnBeforeSolve>

Called before an analysis starts to solve.

<onbeforesolve>[function(analysis)]</onbeforesolve>

<OnBodySuppressStateChange>

Called when the body suppress state has been changed.

<OnDraw>

Called when the application is drawn.

<OnDraw2D>

Called when the application is drawn.

<ondraw>[function()]</ondraw>

<OnInit>

Called when the given context is initialized.

<oninit>[function name(application context)] </oninit>

<OnLoad>

Called when a project is loaded.

<onload>[function(currentFolder)]</onload>

<OnMeshCleaned>

Called when the mesh is cleaned.

<OnMeshGenerated>

Called when the mesh is generated.

<OnPostFinished>

Called when the postprocessing ends for a given analysis.

<onpostfinished>[function(analysis)]</onpostfinished>

<OnPostStarted>

Called when the postprocessing starts for a given analysis.

<onpoststarted>[function(analysis)]</onpoststarted>

<OnReady>

Called when the application is fully loaded and in a "ready" state.

<OnSave>

Called when the project is saved.

<onsave>[function(currentFolder)]</onsave>

<OnTerminate>

Called when the given context is terminated.

<onterminate>[function(context)]</onterminate>

<Resume>

Called when a project is loaded.

<resume>[function(binary reader)]</resume>

<Save>

Called when a project is saved.

<save>[function(binary writer)]</save>


Release 18.2 - © ANSYS, Inc. All rights reserved.