Bexel Manager API Documentation
Public Member Functions | Properties | List of all members
Bexel.Api.ReadOnlyPropertyCollection Class Referenceabstract

More...

Inheritance diagram for Bexel.Api.ReadOnlyPropertyCollection:
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

IEnumerator< Property > GetEnumerator ()
 
abstract 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...
 
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...
 
abstract bool ContainsKey (int definitionID)
 Determines whether the collection contains the property with the specified internal property definition ID. More...
 

Properties

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

Member Function Documentation

◆ ContainsKey() [1/3]

bool Bexel.Api.ReadOnlyPropertyCollection.ContainsKey ( PropertyDefinition  definition)

Determines whether the collection contains the property with the specified property definition.

Parameters
definitionProperty definition of the property.
Returns
True if property with the specified property definition exists, False otherwise.

Implements Bexel.Api.IReadOnlyPropertyCollection.

◆ ContainsKey() [2/3]

bool Bexel.Api.ReadOnlyPropertyCollection.ContainsKey ( PropertyDefinitionID  definitionID)

Determines whether the collection contains the property with the specified property definition ID.

Parameters
definitionIDProperty definition ID of the property.
Returns
True if property with the specified property definition ID exists, False otherwise.

Implements Bexel.Api.IReadOnlyPropertyCollection.

◆ ContainsKey() [3/3]

abstract bool Bexel.Api.ReadOnlyPropertyCollection.ContainsKey ( int  internalDefinitionID)
pure virtual

Determines whether the collection contains the property with the specified internal property definition ID.

Parameters
internalDefinitionIDInternal property definition ID of the property.
Returns
True if property with the specified internal property definition ID exists, False otherwise.

Implements Bexel.Api.IReadOnlyPropertyCollection.

Implemented in Bexel.Api.ElementProperties, Bexel.Api.ElementSourceProperties, Bexel.Api.BuildingProperties, Bexel.Api.BuildingStoreyProperties, Bexel.Api.FamilyProperties, Bexel.Api.MaterialProperties, and Bexel.Api.ElementSystemProperties.

◆ GetPropertyByDefinition()

Property Bexel.Api.ReadOnlyPropertyCollection.GetPropertyByDefinition ( PropertyDefinition  definition)

Retrieves the property with the specified property definition.

Parameters
definitionProperty definition of the property.
Returns
A property with the specified property definition, null if no such property exists within the collection.

Implements Bexel.Api.IReadOnlyPropertyCollection.

◆ GetPropertyByDefinitionID() [1/2]

abstract Property Bexel.Api.ReadOnlyPropertyCollection.GetPropertyByDefinitionID ( int  internalDefinitionID)
pure virtual

Retrieves the property with the specified internal property definition ID.

Parameters
internalDefinitionIDInternal 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.IReadOnlyPropertyCollection.

Implemented in Bexel.Api.ElementProperties, Bexel.Api.ElementSourceProperties, Bexel.Api.BuildingProperties, Bexel.Api.BuildingStoreyProperties, Bexel.Api.FamilyProperties, Bexel.Api.MaterialProperties, and Bexel.Api.ElementSystemProperties.

◆ GetPropertyByDefinitionID() [2/2]

Property Bexel.Api.ReadOnlyPropertyCollection.GetPropertyByDefinitionID ( PropertyDefinitionID  definitionID)

Retrieves the property with the specified property definition ID.

Parameters
definitionIDProperty definition ID of the property.
Returns
A property with the specified property definition ID, null if no such property exists within the collection.

Implements Bexel.Api.IReadOnlyPropertyCollection.

◆ GetPropertyByName()

Property Bexel.Api.ReadOnlyPropertyCollection.GetPropertyByName ( string  name)

Retrieves the property with the specified name.

Parameters
nameThe name of the property.
Returns
A property with the specified name, null if no such property exists within the collection.

Implements Bexel.Api.IReadOnlyPropertyCollection.