API Reference

Detailed and full API reference helps you master Tekla development

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

ModelObject Methods

The ModelObject type exposes the following members.

Methods
  Name Description
Public method CompareTo
Compares Identifiers of model objects.
Public method Delete
Deletes the instance from the model database.
Public method Equals
Check if Identifiers of model objects are same.
Public methodCode example GetAllReportProperties
Retrieves all properties for the model object in one hashtable. Type for the returned value must be checked using type casting.
Public method GetAllUserProperties
Retrieves all properties for the model object in one hashtable. Type for the returned value must be checked using type casting.
Public method GetChildren
Returns an enumerator of all the children model objects.
Public method GetCoordinateSystem
Returns the coordinate system for the given model object.
Public method GetDoubleReportProperties
Retrieves multiple double report properties for the model object. It is faster to fetch multiple properties at once.
Public method GetDoubleUserProperties
Retrieves all double properties for the model object.
Public method GetDynamicStringProperty
Gets a dynamic string property from the model object.
Public method GetFatherComponent
Returns the father component of the model object.
Public method GetHierarchicObjects
Returns an enumerator of all the connected hierarchic objects.
Public method GetIntegerReportProperties
Retrieves multiple integer report properties for the model object. It is faster to fetch multiple properties at once.
Public method GetIntegerUserProperties
Retrieves all integer properties for the model object.
Public method GetPhase
Retrieves the phase of the model object (the phase number, the phase name, the phase comment and whether the phase is the current one or not).
Public method GetReportProperty(String, Double)
Retrieves a double property of the report for the model object.
Public method GetReportProperty(String, Int32)
Retrieves an integer property of the report for the model object.
Public method GetReportProperty(String, String)
Retrieves a string property of the report for the model object.
Public method GetStringReportProperties
Retrieves multiple string report properties for the model object. It is faster to fetch multiple properties at once.
Public method GetStringUserProperties
Retrieves all string properties for the model object.
Public method GetUserProperty(String, Double)
Retrieves a double property for the model object.
Public method GetUserProperty(String, Int32)
Retrieves an integer property for the model object.
Public method GetUserProperty(String, String)
Retrieves a string property for the model object.
Public method Insert
Inserts the model object instance into the model database.
Public method Modify
Modifies the model instance in the model database.
Public method Select
Selects the model object instance from the model database.
Public method SetDynamicStringProperty
Sets a dynamic string property for the model object.
Public method SetLabel
Sets a label for an object when a new instance is created. The label is used in plug-ins for identifying the changed object in modification.
Public method SetPhase
Sets the phase of the model object.
Public method SetUserProperty(String, Double)
Sets a double property for the model object.
Public method SetUserProperty(String, Int32)
Sets an integer property for the model object.
Public method SetUserProperty(String, String)
Sets a string property for the model object.
Top
See Also