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: 2023.0.3
Syntax
[SerializableAttribute]
public class UserPropertyItem

The UserPropertyItem type exposes the following members.

Constructors
  NameDescription
Public methodUserPropertyItem
Creates a new user property item instance.
Top
Properties
  NameDescription
Public propertyAffectsNumbering
Indicates whether the property value affects the numbering of objects.
Public propertyFieldType
The field type of the user property.
Public propertyLevel
The level at which the user property has been defined.
Public propertyName
The name of the user property.
Public propertyType
The type of the user property.
Public propertyUnique
Indicates whether the property value is copied when the object is copied.
Public propertyVisibility
Indicates whether the property value is visible/editable.
Top
Methods
  NameDescription
Public methodAddToObjectType
Adds the user property item to the given object type.
Public methodDelete
Deletes the user property item from the database.
Public methodGetDefaultValue(Double)
Gets the default value of a double property.
Public methodGetDefaultValue(Int32)
Gets the default value of an integer property.
Public methodGetDefaultValue(String)
Gets the default value of a string property.
Public methodGetLabel
Gets the label of the user property. Labels are translated when translation is available.
Public methodGetLabel(Boolean)
Gets the label of the user property.
Public methodGetObjectTypes
Gets the object types which contain this user property item.
Public methodGetOptions(ListKeyValuePairDouble, String)
Gets the value options of a double property. Option strings are translated when translation is available.
Public methodGetOptions(ListKeyValuePairInt32, String)
Gets the value options of an integer property. Option strings are translated when translation is available.
Public methodGetOptions(ListKeyValuePairString, String)
Gets the value options of a string property. Option strings are translated when translation is available.
Public methodGetOptions(ListKeyValuePairDouble, String, Boolean)
Gets the value options of a double property.
Public methodGetOptions(ListKeyValuePairInt32, String, Boolean)
Gets the value options of an integer property.
Public methodGetOptions(ListKeyValuePairString, String, Boolean)
Gets the value options of a string property.
Public methodInsert
Inserts the user property item to the database.
Public methodModify
Modifies the user property item.
Public methodRemoveFromObjectType
Removes the user property item from the given object type.
Public methodSelect
Selects by name the user property item from the database.
Public methodSetDefaultValue(Double)
Sets the default value of a double property.
Public methodSetDefaultValue(Int32)
Sets the default value of an integer property.
Public methodSetDefaultValue(String)
Sets the default value of a string property.
Public methodSetLabel
Sets the label of the user property.
Public methodSetOptions(ListKeyValuePairDouble, String)
Sets the value options of a double property. The maximum count of options is 400.
Public methodSetOptions(ListKeyValuePairInt32, String)
Sets the value options of an integer property. The maximum count of options is 400.
Public methodSetOptions(ListKeyValuePairString, String)
Sets the value options of a string property. The maximum count of options is 400.
Top
See Also
Was this helpful?
The feedback you give here is not visible to other users. We use your comments to improve the content.
Previous
Next