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.

UserPropertyItem Class

The UserPropertyItem class contains information about the user properties in the Tekla Structures catalog.
Inheritance Hierarchy
SystemObject
  Tekla.Structures.CatalogsUserPropertyItem

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 UserPropertyItem

The UserPropertyItem type exposes the following members.

Constructors
  Name Description
Public method UserPropertyItem
Creates a new user property item instance.
Top
Properties
  Name Description
Public property AffectsNumbering
Indicates whether the property value affects the numbering of objects.
Public property FieldType
The field type of the user property.
Public property Level
The level at which the user property has been defined.
Public property Name
The name of the user property.
Public property Type
The type of the user property.
Public property Unique
Indicates whether the property value is copied when the object is copied.
Public property Visibility
Indicates whether the property value is visible/editable.
Top
Methods
  Name Description
Public method AddToObjectType
Adds the user property item to the given object type.
Public method Delete
Deletes the user property item from the database.
Public method GetDefaultValue(Double)
Gets the default value of a double property.
Public method GetDefaultValue(Int32)
Gets the default value of an integer property.
Public method GetDefaultValue(String)
Gets the default value of a string property.
Public method GetLabel
Gets the label of the user property. Labels are translated when translation is available.
Public method GetLabel(Boolean)
Gets the label of the user property.
Public method GetObjectTypes
Gets the object types which contain this user property item.
Public method GetOptions(ListKeyValuePairDouble, String)
Gets the value options of a double property. Option strings are translated when translation is available.
Public method GetOptions(ListKeyValuePairInt32, String)
Gets the value options of an integer property. Option strings are translated when translation is available.
Public method GetOptions(ListKeyValuePairString, String)
Gets the value options of a string property. Option strings are translated when translation is available.
Public method GetOptions(ListKeyValuePairDouble, String, Boolean)
Gets the value options of a double property.
Public method GetOptions(ListKeyValuePairInt32, String, Boolean)
Gets the value options of an integer property.
Public method GetOptions(ListKeyValuePairString, String, Boolean)
Gets the value options of a string property.
Public method Insert
Inserts the user property item to the database.
Public method Modify
Modifies the user property item.
Public method RemoveFromObjectType
Removes the user property item from the given object type.
Public method Select
Selects by name the user property item from the database.
Public method SetDefaultValue(Double)
Sets the default value of a double property.
Public method SetDefaultValue(Int32)
Sets the default value of an integer property.
Public method SetDefaultValue(String)
Sets the default value of a string property.
Public method SetLabel
Sets the label of the user property.
Public method SetOptions(ListKeyValuePairDouble, String)
Sets the value options of a double property.
Public method SetOptions(ListKeyValuePairInt32, String)
Sets the value options of an integer property.
Public method SetOptions(ListKeyValuePairString, String)
Sets the value options of a string property.
Top
See Also