Bexel.Api.IReadOnlyPropertyCollection Interface Reference

Represents a read-only collection of Bexel.Api.Propertys. More...

Inheritance diagram for Bexel.Api.IReadOnlyPropertyCollection:

Public Member Functions
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...

Properties
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 Bexel.Api.Propertys.

Member Function Documentation

ContainsKey() [1/3]

bool Bexel.Api.IReadOnlyPropertyCollection.ContainsKey

(

PropertyDefinition

definition

)

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

Parameters

definition

Property definition of the property.

Returns

True if property with the specified property definition exists, False otherwise.

Implemented in Bexel.Api.ReadOnlyPropertyCollection.

ContainsKey() [2/3]

bool Bexel.Api.IReadOnlyPropertyCollection.ContainsKey

(

PropertyDefinitionID

definitionID

)

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

Parameters

definitionID

Property definition ID of the property.

Returns

True if property with the specified property definition ID exists, False otherwise.

Implemented in Bexel.Api.ReadOnlyPropertyCollection.

ContainsKey() [3/3]

bool Bexel.Api.IReadOnlyPropertyCollection.ContainsKey

(

int

internalDefinitionID

)

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.

Implemented in Bexel.Api.ReadOnlyPropertyCollection, 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.IReadOnlyPropertyCollection.GetPropertyByDefinition

(

PropertyDefinition

definition

)

Retrieves the property with the specified property definition.

Parameters

definition

Property definition of the property.

Returns

A property with the specified property definition, null if no such property exists within the collection.

Implemented in Bexel.Api.ReadOnlyPropertyCollection.

GetPropertyByDefinitionID() [1/2]

Property Bexel.Api.IReadOnlyPropertyCollection.GetPropertyByDefinitionID

(

PropertyDefinitionID

definitionID

)

Retrieves the property with the specified property definition ID.

Parameters

definitionID

Property definition ID of the property.

Returns

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

Implemented in Bexel.Api.ReadOnlyPropertyCollection.

GetPropertyByDefinitionID() [2/2]

Property Bexel.Api.IReadOnlyPropertyCollection.GetPropertyByDefinitionID

(

int

internalDefinitionID

)

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.

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

GetPropertyByName()

Property Bexel.Api.IReadOnlyPropertyCollection.GetPropertyByName

(

string

name

)

Retrieves the property with the specified name.

Parameters

name	The name of the property.

Returns

A property with the specified name, null if no such property exists within the collection.

Implemented in Bexel.Api.ReadOnlyPropertyCollection.

Property Documentation

this[int internalDefinitionID]

Property Bexel.Api.IReadOnlyPropertyCollection.this[int internalDefinitionID]

get

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.

Exceptions

System.Collections.Generic.KeyNotFoundException

No property with the specified internal property definition ID exists within the collection.

this[PropertyDefinition definition]

Property Bexel.Api.IReadOnlyPropertyCollection.this[PropertyDefinition definition]

get

Retrieves the property with the specified property definition.

Parameters

definition

Property definition of the property.

Returns

A property with the specified property definition.

Exceptions

System.Collections.Generic.KeyNotFoundException

No property with the specified property definition exists within the collection.

this[PropertyDefinitionID definitionID]

Property Bexel.Api.IReadOnlyPropertyCollection.this[PropertyDefinitionID definitionID]

get

Retrieves the property with the specified property definition ID.

Parameters

definitionID

Property definition ID of the property.

Returns

A property with the specified property definition ID.

Exceptions

System.Collections.Generic.KeyNotFoundException

No property with the specified property definition ID exists within the collection.