Tekla Open API

Detailed and full API reference helps you master Tekla Open API

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

ComponentItem Class

The ComponentItem class contains information about the components in the Tekla Structures catalog.
Inheritance Hierarchy
SystemObject
  Tekla.Structures.CatalogsComponentItem

Namespace:  Tekla.Structures.Catalogs
Assembly:  Tekla.Structures.Catalogs (in Tekla.Structures.Catalogs.dll) Version: 2019.0.0.0 (2019.0.0.0)
Syntax
[SerializableAttribute]
public class ComponentItem

The ComponentItem type exposes the following members.

Constructors
  Name Description
Public method ComponentItem
Creates a new component item instance.
Top
Properties
  Name Description
Public property AttributeFileExtension
Gets the attribute file extension of item from the component database.
Public property Name
The component item's internal name which is used by Tekla Structures in component identification.
Public property Number
The component item's internal number which is used by Tekla Structures in component identification.
Public property Type
The component item's type.
Public property UIName
The component item's name which is visible in the Tekla Structures user interface.
Top
Methods
  Name Description
Public methodCode example Export
Exports the custom component item in *.uel-format to the to given file name. If path is not given custom component is exported to model folder. If filename is empty custom component name is used as filename.
Public method GetVersion
Gets the version number of custom component item from the component database.
Public method Select(String, Int32)
Selects the component item from the component database. Uses the type if defined for selection
Public method Select(String, Int32, ComponentItemComponentTypeEnum)
Selects the component item from the component database.
Top
See Also