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.

CatalogHandler Class

The CatalogHandler class is a class from which the user can query catalog instances.
Inheritance Hierarchy
SystemObject
  Tekla.Structures.CatalogsCatalogHandler

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 CatalogHandler

The CatalogHandler type exposes the following members.

Constructors
  Name Description
Public method CatalogHandler
Creates a new catalog handler instance.
Top
Methods
  Name Description
Public method GetBoltItems
Returns an enumerator of all bolt items.
Public method GetComponentItems
Returns an enumerator of all component items.
Public method GetConnectionStatus
Returns true if a proper connection to the Tekla Structures process has been established. Currently, there's no way to re-establish the connection.
Public method GetDrawingItems
Returns an enumerator of all drawing items.
Public method GetLibraryProfileItems
Returns an enumerator of library profile items.
Public method GetMaterialItems
Returns an enumerator of all material items.
Public method GetMaterialMarketSizes
Returns an enumerator of all material marketsizes. Data is read from XS_PROFDB\marketsizes.dat file.
Public method GetMeshItems
Returns an enumerator of mesh items.
Public method GetParametricProfileItems
Returns an enumerator of parametric profile items.
Public method GetPrinterItems
Returns an enumerator of all printer items.
Public method GetProfileItems
Returns an enumerator of all profile items.
Public method GetRebarItems
Returns an enumerator of rebar items.
Public method GetShapeItems
Returns an enumerator of all shape items.
Public method GetUserPropertyItems
Returns an enumerator of all user property items.
Public method GetUserPropertyItems(CatalogObjectTypeEnum)
Returns an enumerator of user property items of the given object type.
Public methodCode example ImportBoltItems
Imports bolt items and their assembly information (*.bass) from folder to bolt assembly catalog and bolt catalog. Import overrides the existing bolts in the catalog without any warnings.
Public methodCode example ImportCustomComponentItems
Imports custom component items (*.uel) from path to component catalog. Import overrides the existing custom components in the catalog without any warnings.
Public methodCode example ImportDrawingItems
Imports drawing setting items (*.tsds) from specified folder to model folder. Import throws exception if model is not open. Import overrides the existing drawing items in the catalog without any warnings.
Public methodCode example ImportLibraryProfileItems
Imports library profile items (*.lis) from folder to profile catalog. Import overrides the existing profiles in the catalog without any warnings.
Public methodCode example ImportMaterialItems
Imports material items (*.lis) from folder to material catalog. Import overrides the existing materials in the catalog without any warnings.
Public methodCode example ImportMeshItems
Imports mesh items (*.mexp) from folder to mesh catalog. Import overrides the existing mesh item in the catalog without any warnings.
Public methodCode example ImportParametricProfileItems
Imports parametric profile items (*.uel) from folder to profile catalog. Import overrides the existing profiles in the catalog without any warnings.
Public methodCode example ImportRebarItems
Imports rebar items (*.rexp) from folder to reinforcement catalog. Import overrides the existing rebar item in the catalog without any warnings.
Public methodCode example ImportShapeItems
Imports shape geometry items (*.tsc) from specified folder. Import throws exception if model is not open. Import overrides the existing shape items in the catalog without any warnings.
Top
See Also