Bexel.Api.ElementSourceProperties Class Reference
Represents a read-only collection of properties within the Bexel.Api.ElementSource. More...
Inheritance diagram for Bexel.Api.ElementSourceProperties:
Public Member Functions | |||||||||
| override Property | GetPropertyByDefinitionID (int internalDefinitionID) | ||||||||
| Retrieves the property with the specified internal property definition ID. More... | |||||||||
| override bool | ContainsKey (int internalDefinitionID) | ||||||||
| Determines whether the collection contains the property with the specified internal property definition ID. More... | |||||||||
 Public Member Functions inherited from Bexel.Api.PropertyCollection | |||||||||
| Property | Add (string propertyName, string propertyGroupName, object value, PropertyDefinitionUnitType? unitType=PropertyDefinitionUnitType.Numeric) | ||||||||
| |||||||||
| 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, 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... | |||||||||
| virtual 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.ReadOnlyPropertyCollection | |||||||||
| IEnumerator< Property > | GetEnumerator () | ||||||||
| Property | GetPropertyByName (string name) | ||||||||
| Retrieves the property with the specified name. More... | |||||||||
| 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... | |||||||||
| 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... | |||||||||
Protected Member Functions | |
| override bool | IsPropertyReadOnly (string propertyName) |
Properties | |
| override Project | Project [get] |
| override PropertySet | PropertySet [get] |
| Properties inherited from Bexel.Api.PropertyCollection | |
| abstract PropertySet | PropertySet [get] |
| override IReadOnlyDictionary< string, PropertyRef > | PropertyCollectionRef [get] |
| Properties inherited from Bexel.Api.ReadOnlyPropertyCollection | |
| abstract Project | Project [get] |
| abstract IReadOnlyDictionary< string, PropertyRef > | PropertyCollectionRef [get] |
| int | Count [get] |
| Property | this[PropertyDefinition definition] [get] |
| Property | this[PropertyDefinitionID definitionID] [get] |
| Property | this[int internalDefinitionID] [get] |
| 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 read-only collection of properties within the Bexel.Api.ElementSource.
Member Function Documentation
◆ ContainsKey()
|
virtual |
Determines whether the collection contains the property with the specified internal property definition ID.
- Parameters
-
internalDefinitionID Internal property definition ID of the property.
- Returns
- True if property with the specified internal property definition ID exists, False otherwise.
Implements Bexel.Api.ReadOnlyPropertyCollection.
◆ GetPropertyByDefinitionID()
|
virtual |
Retrieves the property with the specified internal property definition ID.
- Parameters
-
internalDefinitionID Internal property definition ID of the property.
- Returns
- A property with the specified internal property definition ID, null if no such property exists within the collection.
Implements Bexel.Api.ReadOnlyPropertyCollection.
