Bexel Manager API Documentation
Bexel.Api.PropertyDefinition Class Reference

Represents a base object for all properties within a Bexel.Api.Project. More...

Inheritance diagram for Bexel.Api.PropertyDefinition:
Bexel.Api.ApiObject IEquatable

Public Member Functions

bool Equals (PropertyDefinition other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static bool operator== (PropertyDefinition left, PropertyDefinition right)
 
static bool operator!= (PropertyDefinition left, PropertyDefinition right)
 

Properties

override bool IsValid [get]
 
Project Project [get]
 Returns the project in which the property definition resides. More...
 
PropertyDefinitionID ID [get]
 Returns a unique identifier for the property definition a single project. More...
 
CategoryType CategoryType [get]
 Returns the category type to which this property definition is applicable to. More...
 
PropertyDefinitionType Type [get]
 Returns the type of the property definition. More...
 
string Name [get]
 Returns the name of the property definition. More...
 
string GroupName [get]
 Returns the group name of the property definition. More...
 
PropertyDefinitionUnitType UnitType [get]
 Returns the unit type of the property definition (e.g. Numeric, Text etc.). More...
 
PropertyDefinitionUnitNameType UnitNameType [get]
 Returns the unit name type of the property definition (e.g. Meter, Kilogram etc.) More...
 
bool IsContinuous [get]
 Indicates if the property definition describes a continuous value. More...
 
bool IsDiscrete [get]
 Indicates if the property definition describes a discrete value. More...
 
bool IsPredefined [get]
 Indicates if the property definition is predefined. More...
 
- Properties inherited from Bexel.Api.ApiObject
abstract bool IsValid [get]
 Indicates if the API object is valid or not. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Bexel.Api.ApiObject
virtual void CheckValidity ()
 

Detailed Description

Represents a base object for all properties within a Bexel.Api.Project.

Property Documentation

◆ CategoryType

CategoryType Bexel.Api.PropertyDefinition.CategoryType
get

Returns the category type to which this property definition is applicable to.

◆ GroupName

string Bexel.Api.PropertyDefinition.GroupName
get

Returns the group name of the property definition.

◆ ID

PropertyDefinitionID Bexel.Api.PropertyDefinition.ID
get

Returns a unique identifier for the property definition a single project.

◆ IsContinuous

bool Bexel.Api.PropertyDefinition.IsContinuous
get

Indicates if the property definition describes a continuous value.

◆ IsDiscrete

bool Bexel.Api.PropertyDefinition.IsDiscrete
get

Indicates if the property definition describes a discrete value.

◆ IsPredefined

bool Bexel.Api.PropertyDefinition.IsPredefined
get

Indicates if the property definition is predefined.

◆ Name

string Bexel.Api.PropertyDefinition.Name
get

Returns the name of the property definition.

◆ Project

Project Bexel.Api.PropertyDefinition.Project
get

Returns the project in which the property definition resides.

◆ Type

PropertyDefinitionType Bexel.Api.PropertyDefinition.Type
get

Returns the type of the property definition.

◆ UnitNameType

PropertyDefinitionUnitNameType Bexel.Api.PropertyDefinition.UnitNameType
get

Returns the unit name type of the property definition (e.g. Meter, Kilogram etc.)

◆ UnitType

PropertyDefinitionUnitType Bexel.Api.PropertyDefinition.UnitType
get

Returns the unit type of the property definition (e.g. Numeric, Text etc.).