API Reference

Detailed and full API reference helps you master Tekla development

  1. Tekla Structures
  2. Tekla Open API 2023 Reference
  3. PluginBase.DefineInput Method

This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

PluginBaseDefineInput Method

The method Tekla Structures calls for the plug-in to query the input. The plug-in must then return a list of input definition instances. The plug-in will be dependent on the items it returns. Dependent means that if any of these items change, for example the user moves the points, the plug-in will be re-run with new input. DefineInput is not called during the re-run, and thus all the actual implementation should be in the Run() method. The maximum number of InputDefinitions in the List is 10.

Namespace:  Tekla.Structures.Plugins
Assembly:  Tekla.Structures.Plugins (in Tekla.Structures.Plugins.dll) Version: 2023.0.1
Syntax
Copy
public abstract List<PluginBaseInputDefinition> DefineInput()

Return Value

Type: ListPluginBaseInputDefinition
A list of input definition instances. If the plug-in is not dependent on input, it should return an empty list (not null).
See Also