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.

ParametricProfileItem Class

The ParametricProfileItem class contains information from parametric profiles in the catalog. Parametric profile items can be enumerated using a profile item enumerator.
Inheritance Hierarchy
SystemObject
  Tekla.Structures.CatalogsProfileItem
    Tekla.Structures.CatalogsParametricProfileItem

Namespace:  Tekla.Structures.Catalogs
Assembly:  Tekla.Structures.Catalogs (in Tekla.Structures.Catalogs.dll) Version: 2019.0.0.0 (2019.0.0.0)
Syntax
public sealed class ParametricProfileItem : ProfileItem

The ParametricProfileItem type exposes the following members.

Constructors
  Name Description
Public method ParametricProfileItem
Creates a new parametric profile item instance.
Top
Properties
  Name Description
Public property aProfileItemParameters
An array list with the profile item parameters.
(Inherited from ProfileItem.)
Public property IsMultiCrossSectionUserParametric
Whether the profile is a parametric user-defined multi cross section profile.
(Inherited from ProfileItem.)
Public property IsSketchedUserParametric
Whether the profile is a parametric user-defined sketched profile.
(Inherited from ProfileItem.)
Public property NumberOfCrossSections
The number of cross sections in the profile item.
(Inherited from ProfileItem.)
Public property ParameterString
The profile item parameter string.
(Inherited from ProfileItem.)
Public property ProfileItemSubType
The profile item subtype.
(Inherited from ProfileItem.)
Public property ProfileItemType
The profile item type.
(Inherited from ProfileItem.)
Public property ProfilePrefix
The parametric profile item prefix.
Top
Methods
  Name Description
Public method CreateProfileString
Gets the parametric profile item prefix and adds parameter values.
Public methodCode example Export
Exports the profile item in the profile database to given file name. Currently library profiles, sketch profiles and clb profiles are supported. Library profiles are exported to *.lis format. Sketch profiles are exported to *.uel format. Clb profiles are exported to *.clb format. If path is not given profile is exported to model folder. If filename is empty profile name or prefix is used as filename.
(Inherited from ProfileItem.)
Public methodCode example GetCrossSection
Returns list of cross section points of inner surfaces from the profile item.
(Inherited from ProfileItem.)
Public methodStatic member GetParametricProfilePrefix
Gets the parametric profile item prefix using the given subtype. This can be used after retrieving a library profile that has a parametric user-defined type.
Public method IsProfileUserDefined
Whether the profile is a fixed user-defined profile.
(Inherited from ProfileItem.)
Public method IsProfileUserParametric
Whether the profile is a parametric user-defined profile. If so, the prefix can be asked by type and subtype.
(Inherited from ProfileItem.)
Public method Select
Selects the profile item in the profile database.
(Inherited from ProfileItem.)
Public method Select(String)
Selects the parametric profile item in the profile database using the given name.
Top
Examples
It is possible to select a parametric profile item by its name:
using Tekla.Structures.Catalogs;

public class Example
{
       public void Example1()
       {
           ParametricProfileItem ParametricProfileItem = new ParametricProfileItem();
           ParametricProfileItem.ProfilePrefix = "PHI";
           ParametricProfileItem.Select();
       }
}
See Also