Bexel Manager API Documentation
Bexel.Api.IPropertyCollection Interface Reference

Represents a collection of Bexel.Api.Propertys. More...

Inheritance diagram for Bexel.Api.IPropertyCollection:
Bexel.Api.IReadOnlyPropertyCollection IReadOnlyCollection Bexel.Api.PropertyCollection Bexel.Api.BuildingProperties Bexel.Api.BuildingStoreyProperties Bexel.Api.ElementProperties Bexel.Api.ElementSourceProperties Bexel.Api.ElementSystemProperties Bexel.Api.FamilyProperties Bexel.Api.MaterialProperties

Public Member Functions

Property Add (string propertyName, string propertyGroupName, object value, PropertyDefinitionUnitType? unitType=PropertyDefinitionUnitType.Numeric)
 
Parameters
propertyNameName of the property to be added.
propertyGroupNameGroup name of the property to be added.
valueValue of the property to be added.
unitTypeUnit type of the property to be added.
Returns
Newly created property if add is successful, null if add failed or the property with the specified name already exists.
More...
 
Property Add (string propertyName, string propertyGroupName, bool value=false)
 Adds new Bexel.Api.PropertyBool into the collection. More...
 
Property Add (string propertyName, string propertyGroupName, Color? value=null)
 Adds new Bexel.Api.PropertyColor into the collection. More...
 
Property Add (string propertyName, string propertyGroupName, DateTime? value=null)
 Adds new Bexel.Api.PropertyDateTime into the collection. More...
 
Property Add (string propertyName, string propertyGroupName, double value=0.0, PropertyDefinitionUnitType unitType=PropertyDefinitionUnitType.Numeric)
 Adds new Bexel.Api.PropertyNumeric into the collection. More...
 
Property Add (string propertyName, string propertyGroupName, string value=null)
 Adds new Bexel.Api.PropertyString into the collection. More...
 
Property Add (string propertyName, string propertyGroupName, TimeSpan? value=null)
 Adds new Bexel.Api.PropertyTimeSpan into the collection. More...
 
Property AddPropertyExpression (string propertyName, string propertyGroupName, string expression, PropertyDefinitionUnitType unitType=PropertyDefinitionUnitType.Numeric)
 Adds new Bexel.Api.PropertyNumericExpresion into the collection. More...
 
bool Remove (Property property)
 Removes a specified property from the collection. More...
 
bool Remove (string propertyName)
 Removes the property with a specified name from the collection. More...
 
void RemoveRange (IEnumerable< Property > properties)
 Removes a specified properties from the collection. More...
 
void RemoveRange (IEnumerable< string > propertyNames)
 Removes the properties with a specified names from the collection. More...
 
bool Update (Property property, object value)
 Updates a value of the specified property. More...
 
bool Update (string propertyName, object value)
 Updates a value of the property with a specified name. More...
 
bool UpdatePropertyExpression (Property property, string expression)
 Updates an expression of the specified property. More...
 
bool UpdatePropertyExpression (string propertyName, string expression)
 Updates an expression of the property with a specified name. More...
 
- Public Member Functions inherited from Bexel.Api.IReadOnlyPropertyCollection
Property GetPropertyByDefinition (PropertyDefinition definition)
 Retrieves the property with the specified property definition. More...
 
Property GetPropertyByDefinitionID (PropertyDefinitionID definitionID)
 Retrieves the property with the specified property definition ID. More...
 
Property GetPropertyByDefinitionID (int internalDefinitionID)
 Retrieves the property with the specified internal property definition ID. More...
 
Property GetPropertyByName (string name)
 Retrieves the property with the specified name. More...
 
bool ContainsKey (PropertyDefinition definition)
 Determines whether the collection contains the property with the specified property definition. More...
 
bool ContainsKey (PropertyDefinitionID definitionID)
 Determines whether the collection contains the property with the specified property definition ID. More...
 
bool ContainsKey (int internalDefinitionID)
 Determines whether the collection contains the property with the specified internal property definition ID. More...
 

Additional Inherited Members

- Properties inherited from Bexel.Api.IReadOnlyPropertyCollection
Property this[PropertyDefinition definition] [get]
 Retrieves the property with the specified property definition. More...
 
Property this[PropertyDefinitionID definitionID] [get]
 Retrieves the property with the specified property definition ID. More...
 
Property this[int internalDefinitionID] [get]
 Retrieves the property with the specified internal property definition ID. More...
 

Detailed Description

Represents a collection of Bexel.Api.Propertys.

Member Function Documentation

◆ Add() [1/7]

Property Bexel.Api.IPropertyCollection.Add ( string  propertyName,
string  propertyGroupName,
object  value,
PropertyDefinitionUnitType unitType = PropertyDefinitionUnitType.Numeric 
)

Parameters
propertyNameName of the property to be added.
propertyGroupNameGroup name of the property to be added.
valueValue of the property to be added.
unitTypeUnit type of the property to be added.
Returns
Newly created property if add is successful, null if add failed or the property with the specified name already exists.

Implemented in Bexel.Api.PropertyCollection.

◆ Add() [2/7]

Property Bexel.Api.IPropertyCollection.Add ( string  propertyName,
string  propertyGroupName,
bool  value = false 
)

Adds new Bexel.Api.PropertyBool into the collection.

Parameters
propertyNameName of the property to be added.
propertyGroupNameGroup name of the property to be added.
valueValue of the property to be added.
Returns
Newly created property if add is successful, null if add failed or the property with the specified name already exists.

Implemented in Bexel.Api.PropertyCollection.

◆ Add() [3/7]

Property Bexel.Api.IPropertyCollection.Add ( string  propertyName,
string  propertyGroupName,
Color?  value = null 
)

Adds new Bexel.Api.PropertyColor into the collection.

Parameters
propertyNameName of the property to be added.
propertyGroupNameGroup name of the property to be added.
valueValue of the property to be added.
Returns
Newly created property if add is successful, null if add failed or the property with the specified name already exists.

Implemented in Bexel.Api.PropertyCollection.

◆ Add() [4/7]

Property Bexel.Api.IPropertyCollection.Add ( string  propertyName,
string  propertyGroupName,
DateTime?  value = null 
)

Adds new Bexel.Api.PropertyDateTime into the collection.

Parameters
propertyNameName of the property to be added.
propertyGroupNameGroup name of the property to be added.
valueValue of the property to be added.
Returns
Newly created property if add is successful, null if add failed or the property with the specified name already exists.

Implemented in Bexel.Api.PropertyCollection.

◆ Add() [5/7]

Property Bexel.Api.IPropertyCollection.Add ( string  propertyName,
string  propertyGroupName,
double  value = 0.0,
PropertyDefinitionUnitType  unitType = PropertyDefinitionUnitType.Numeric 
)

Adds new Bexel.Api.PropertyNumeric into the collection.

Parameters
propertyNameName of the property to be added.
propertyGroupNameGroup name of the property to be added.
valueValue of the property to be added.
unitTypeUnit type of the property to be added.
Returns
Newly created property if add is successful, null if add failed or the property with the specified name already exists.

Implemented in Bexel.Api.PropertyCollection.

◆ Add() [6/7]

Property Bexel.Api.IPropertyCollection.Add ( string  propertyName,
string  propertyGroupName,
string  value = null 
)

Adds new Bexel.Api.PropertyString into the collection.

Parameters
propertyNameName of the property to be added.
propertyGroupNameGroup name of the property to be added.
valueValue of the property to be added.
Returns
Newly created property if add is successful, null if add failed or the property with the specified name already exists.

Implemented in Bexel.Api.PropertyCollection.

◆ Add() [7/7]

Property Bexel.Api.IPropertyCollection.Add ( string  propertyName,
string  propertyGroupName,
TimeSpan?  value = null 
)

Adds new Bexel.Api.PropertyTimeSpan into the collection.

Parameters
propertyNameName of the property to be added.
propertyGroupNameGroup name of the property to be added.
valueValue of the property to be added.
Returns
Newly created property if add is successful, null if add failed or the property with the specified name already exists.

Implemented in Bexel.Api.PropertyCollection.

◆ AddPropertyExpression()

Property Bexel.Api.IPropertyCollection.AddPropertyExpression ( string  propertyName,
string  propertyGroupName,
string  expression,
PropertyDefinitionUnitType  unitType = PropertyDefinitionUnitType.Numeric 
)

Adds new Bexel.Api.PropertyNumericExpresion into the collection.

Parameters
propertyNameName of the property to be added.
propertyGroupNameGroup name of the property to be added.
expressionExpression of the property to be added.
unitTypeUnit type of the property to be added.
Returns
Newly created property if add is successful, null if add failed or the property with the specified name already exists.

Implemented in Bexel.Api.PropertyCollection.

◆ Remove() [1/2]

bool Bexel.Api.IPropertyCollection.Remove ( Property  property)

Removes a specified property from the collection.

Parameters
propertyThe property to be removed.
Returns
True if property is successfully removed, False if property was not removed or was not found in the collection.

Implemented in Bexel.Api.PropertyCollection.

◆ Remove() [2/2]

bool Bexel.Api.IPropertyCollection.Remove ( string  propertyName)

Removes the property with a specified name from the collection.

Parameters
propertyNameName of the property to be removed.
Returns
True if property is successfully removed, False if property with a specified name was not removed or was not found in the collection.

Implemented in Bexel.Api.PropertyCollection.

◆ RemoveRange() [1/2]

void Bexel.Api.IPropertyCollection.RemoveRange ( IEnumerable< Property properties)

Removes a specified properties from the collection.

Parameters
propertiesThe properties to be removed.

Implemented in Bexel.Api.PropertyCollection.

◆ RemoveRange() [2/2]

void Bexel.Api.IPropertyCollection.RemoveRange ( IEnumerable< string >  propertyNames)

Removes the properties with a specified names from the collection.

Parameters
propertyNamesNames of the properties to be removed.

Implemented in Bexel.Api.PropertyCollection.

◆ Update() [1/2]

bool Bexel.Api.IPropertyCollection.Update ( Property  property,
object  value 
)

Updates a value of the specified property.

Parameters
propertyThe property which value will be updated.
valueValue of the property.
Returns
True if property is successfully updated, False if property was not updated or was not found in the collection.
Exceptions
System.ArgumentExceptionThrown when a value parameter of wrong type is specified.

Implemented in Bexel.Api.PropertyCollection.

◆ Update() [2/2]

bool Bexel.Api.IPropertyCollection.Update ( string  propertyName,
object  value 
)

Updates a value of the property with a specified name.

Parameters
propertyNameThe name of the property which value will be updated.
valueValue of the property.
Returns
True if property is successfully removed, False if property with a specified name was not removed or was not found in the collection.
Exceptions
System.ArgumentExceptionThrown when a value parameter of wrong type is specified.

Implemented in Bexel.Api.PropertyCollection.

◆ UpdatePropertyExpression() [1/2]

bool Bexel.Api.IPropertyCollection.UpdatePropertyExpression ( Property  property,
string  expression 
)

Updates an expression of the specified property.

Parameters
propertyThe property which expression will be updated.
expressionExpression of the property.
Returns
True if property is successfully updated, False if property was not updated or was not found in the collection.

Implemented in Bexel.Api.PropertyCollection.

◆ UpdatePropertyExpression() [2/2]

bool Bexel.Api.IPropertyCollection.UpdatePropertyExpression ( string  propertyName,
string  expression 
)

Updates an expression of the property with a specified name.

Parameters
propertyNameThe name of the property which expression will be updated.
expressionExpression of the property.
Returns
True if property is successfully updated, False if property was not updated or was not found in the collection.

Implemented in Bexel.Api.PropertyCollection.