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

C#
C++/CLI

public class UserDefinedPropertyDefinition : PropertyDefinition

public ref class UserDefinedPropertyDefinition : public PropertyDefinition

Remarks

After creating a new UserDefinedPropertyDefinition, you assign it to a property list by the UniversalPropertyList.AddUserPropertyDef(oUserDefinedPropertyDefinition) method

Public Constructors

	Name	Description
	UserDefinedPropertyDefinition Constructor	Default constructor.

Top

Public Properties

	Name	Description
	Category	Category of this property definition.
	DefaultValuesSelectionList	Gets/Sets list of default values for selection list.
	DisplayedName	Name displayed in GUI for this property definition.
	DoNotUse	Gets/Sets a flag which indicates if property will not be longer displayed in project.
	Id	Overridden. Returns AnyPropertyId.
	IdentifyingName	Identifying name of this property definition.
	InputAid	Input aid of this property definition.
	IsAssigned	Returns true, if the property is assigned to at least one property list
	IsDeprecated	Overridden. Allows to check if a given property marked as deprecated.
	IsIndexed	Allows to check if a given property is indexed (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	IsInternal	Allows to check if a given property marked as internal. Don't use this property. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	IsNamePart	Allows to check if a given property is name part. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	IsPropertyLicensed	Allows to check if a given property is licensed. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	IsReadOnly	Allows to check if a given property is read-only. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	LowerBound	Gets a property's minimal value specified in the property's definition. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	MaxIndex	Allows to check maximal index of a given property. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	Name	Name of property. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	Project	Returns the project in which this property definition exists.
	Type	Returns information about type of the property. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	UpperBound	Gets a property's maximal value specified in the property's definition. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	Usages	Usages of this property definition.

Top

Public Methods

	Name	Description
	Create	Overloaded. Creates new property definition.
	Dispose()	Destructor for deterministic finalization of UserDefinedPropertyDefinition object. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	GetAsDisplayString	Returns the display string used for a given property value. Returns the display string used for a given property value. (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)
	ValidateValue	Returns the display string used for a given property value. Validates passed value with property definition (Inherited from Eplan.EplApi.DataModel.PropertyDefinition)

Top

Reference

UserDefinedPropertyDefinition Members
Eplan.EplApi.DataModel Namespace

Send Feedback