User Defined Documents: Python Script API

A User Defined Documents (UDD) extension is implemented as an IronPython script that defines a class with a specific name: UDDExtension which derives from a specific base class IUDDPluginExtension and implements its abstract methods.

This API supports multiple data types in the forms of constants and classes. It also has several input interfaces.

User Defined Document scripting commands are provided in this product's scripting guide. An complete example with a line by line explanation of how to use these methods is available.

Import Statements

The base class to be used and the types it uses in turn are contained in .NET assemblies. The use of these requires that the assemblies be imported into the UDD script: the following import statements should be added to the top of the python script:

from Ansys.Ansoft.DocGeneratorPluginDotNet.DocGenerator.API.Data import *
from Ansys.Ansoft.DocGeneratorPluginDotNet.DocGenerator.API.Interfaces import *