Eplan Platform API
Eplan.EplApi.DataModel Namespace / UserDefinedPropertyDefinition Class
Members

In This Topic
    UserDefinedPropertyDefinition Class
    In This Topic
    This class provides information about user-defined properties and makes it possible to create them.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.PropertyDefinition
          Eplan.EplApi.DataModel.UserDefinedPropertyDefinition

    Syntax
    public class UserDefinedPropertyDefinition : PropertyDefinition 
    public ref class UserDefinedPropertyDefinition : public PropertyDefinition
    Remarks
    For more information, please refer to the "User-defined properties" section in the "Eplan properties" chapter.
    Public Constructors
     NameDescription
    Public ConstructorUserDefinedPropertyDefinition ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyCategoryCategory of this property definition.  
    Public PropertyDefaultValuesSelectionListGets/Sets list of default values for selection list.  
    Public PropertyDisplayedNameName displayed in GUI for this property definition.  
    Public PropertyDoNotUseGets/Sets a flag which indicates if property will not be longer displayed in project.  
    Public PropertyGUIReadOnlyGets/Sets a flag which indicates if property is read only in GUI in the project.  
    Public PropertyIdOverridden. Returns AnyPropertyId.  
    Public PropertyIdentifyingNameIdentifying name of this property definition.  
    Public PropertyInputAidInput aid of this property definition.  
    Public PropertyIsAssignedReturns true, if the property is assigned to at least one property list  
    Public PropertyIsDeprecatedOverridden. Allows to check if a given property is marked as deprecated.  
    Public PropertyIsIndexedAllows to check if a given property is indexed. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyIsInternalAllows to check if a given property is marked as internal. Don't use this property. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyIsNamePartAllows to check if a given property is name part. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyIsPropertyLicensedAllows to check if a given property is licensed. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyIsReadOnlyAllows to check if a given property is read-only. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyLowerBoundReturns the minimum value of a property specified in the property definition. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyMaxIndexAllows to check the maximum index of a given property. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyNameName of property. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyProjectReturns the project in which this property definition exists.  
    Public PropertyTypeReturns information about the type of the property. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyUnitGroupUnitGroup of this property definition.  
    Public PropertyUpperBoundReturns the maximum value of a property specified in the property definition. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public PropertyUsagesUsages of this property definition.  
    Top
    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)CreateOverloaded. Creates new property definition.  
    Public MethodDispose()Destructor for deterministic finalization of UserDefinedPropertyDefinition object. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Public MethodValidateValueReturns the display string used for a given property value. Validates whether the value meets the requirements of the property definition. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
    Top
    See Also

    Reference

    UserDefinedPropertyDefinition Members
    Eplan.EplApi.DataModel Namespace

     

     

    Eplan API, 11.10.2025, © by EPLAN GmbH & Co. KG. All rights reserved.

    Use the Eplan Global Support Portal for feedback and support