Bexel.Api.IReadOnlyPropertyDefinitionCollection Interface Reference
Represents a read-only collection of Bexel.Api.PropertyDefinitions. More...
Inheritance diagram for Bexel.Api.IReadOnlyPropertyDefinitionCollection:
Public Member Functions | |
| PropertyDefinition | GetPropertyDefinitionByID (PropertyDefinitionID id) |
| Retrieves the property definition with the specified ID. More... | |
| PropertyDefinition | GetPropertyDefinitionByID (int internalID) |
| Retrieves the property definition with the specified internal ID. More... | |
| PropertyDefinition | GetPropertyDefinitionByName (string name) |
| Retrieves the property definition with the specified name. More... | |
| IEnumerable< PropertyDefinition > | GetPropertyDefinitionByUnitType (PropertyDefinitionUnitType type) |
| Retrieves the property definitions with the specified type. More... | |
| bool | ContainsKey (PropertyDefinitionID id) |
| Determines whether the collection contains the property definition with the specified ID. More... | |
| bool | ContainsKey (int internalID) |
| Determines whether the collection contains the property definition with the specified internal ID. More... | |
Properties | |
| PropertyDefinition | this[PropertyDefinitionID id] [get] |
| Retrieves the property definition with the specified ID. More... | |
| PropertyDefinition | this[int internalID] [get] |
| Retrieves the property definition with the specified internal ID. More... | |
Detailed Description
Represents a read-only collection of Bexel.Api.PropertyDefinitions.
Member Function Documentation
◆ ContainsKey() [1/2]
| bool Bexel.Api.IReadOnlyPropertyDefinitionCollection.ContainsKey | ( | PropertyDefinitionID | id | ) |
Determines whether the collection contains the property definition with the specified ID.
- Parameters
-
id ID of the property definition.
- Returns
- True if property definition with the specified ID exists, False otherwise.
◆ ContainsKey() [2/2]
| bool Bexel.Api.IReadOnlyPropertyDefinitionCollection.ContainsKey | ( | int | internalID | ) |
Determines whether the collection contains the property definition with the specified internal ID.
- Parameters
-
internalID Internal ID of the property definition.
- Returns
- True if property definition with the specified internal ID exists, False otherwise.
◆ GetPropertyDefinitionByID() [1/2]
| PropertyDefinition Bexel.Api.IReadOnlyPropertyDefinitionCollection.GetPropertyDefinitionByID | ( | PropertyDefinitionID | id | ) |
Retrieves the property definition with the specified ID.
- Parameters
-
id ID of the property definition.
- Returns
- A property definition with the specified ID, null if no such property definition exists within the collection.
◆ GetPropertyDefinitionByID() [2/2]
| PropertyDefinition Bexel.Api.IReadOnlyPropertyDefinitionCollection.GetPropertyDefinitionByID | ( | int | internalID | ) |
Retrieves the property definition with the specified internal ID.
- Parameters
-
internalID Internal ID of the property definition.
- Returns
- A property definition with the specified internal ID, null if no such property definition exists within the collection.
◆ GetPropertyDefinitionByName()
| PropertyDefinition Bexel.Api.IReadOnlyPropertyDefinitionCollection.GetPropertyDefinitionByName | ( | string | name | ) |
Retrieves the property definition with the specified name.
- Parameters
-
name Name of the property definition.
- Returns
- A property definition with the specified name, null if no such property definition exists within the collection.
◆ GetPropertyDefinitionByUnitType()
| IEnumerable<PropertyDefinition> Bexel.Api.IReadOnlyPropertyDefinitionCollection.GetPropertyDefinitionByUnitType | ( | PropertyDefinitionUnitType | type | ) |
Retrieves the property definitions with the specified type.
- Parameters
-
type Type of the property definition.
- Returns
- All property definitions with the specified type, empty collection if no such property definitions exist within the collection.
Property Documentation
◆ this[int internalID]
|
get |
Retrieves the property definition with the specified internal ID.
- Parameters
-
internalID Internal ID of the property definition.
- Returns
- A property definition with the specified internal ID.
- Exceptions
-
System.Collections.Generic.KeyNotFoundException No property definition with the specified internal ID exists within the collection.
◆ this[PropertyDefinitionID id]
|
get |
Retrieves the property definition with the specified ID.
- Parameters
-
id ID of the property definition.
- Returns
- A property definition with the specified ID.
- Exceptions
-
System.Collections.Generic.KeyNotFoundException No property definition with the specified ID exists within the collection.
