Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection Interface Reference
Represents a read-only collection of Bexel.Api.Scheduling.TaskPropertys. More...
Inheritance diagram for Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection:
Public Member Functions | |
| bool | ContainsKey (string name) |
| Determines whether the collection contains the property with the specified name. More... | |
| bool | ContainsKey (TaskPropertyDefinitionID definitionID) |
| Determines whether the collection contains the property with the specified property definition ID. More... | |
| bool | TryGetValue (string name, out TaskProperty property) |
| Retrieves the property with the specified name. More... | |
| bool | TryGetValue (TaskPropertyDefinitionID definitionID, out TaskProperty property) |
| Retrieves the property with the specified definition ID. More... | |
| TaskProperty | GetPropertyByName (string name) |
| Retrieves the property with the specified name. More... | |
| TaskProperty | GetPropertyByDefinition (TaskPropertyDefinition definition) |
| Retrieves the property with the specified property definition. More... | |
| TaskProperty | GetPropertyByDefinitionID (TaskPropertyDefinitionID definitionID) |
| Retrieves the property with the specified property definition ID. More... | |
Properties | |
| TaskProperty | this[string name] [get] |
| Retrieves the property with the specified name. More... | |
| TaskProperty | this[TaskPropertyDefinitionID definitionID] [get] |
| Retrieves the property with the specified property definition ID. More... | |
Detailed Description
Represents a read-only collection of Bexel.Api.Scheduling.TaskPropertys.
Member Function Documentation
◆ ContainsKey() [1/2]
| bool Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.ContainsKey | ( | string | name | ) |
Determines whether the collection contains the property with the specified name.
- Parameters
-
name Name of the property.
- Returns
- True if property with the specified name exists, False otherwise.
Implemented in Bexel.Api.Scheduling.TaskProperties.
◆ ContainsKey() [2/2]
| bool Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.ContainsKey | ( | TaskPropertyDefinitionID | 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.Scheduling.TaskProperties.
◆ GetPropertyByDefinition()
| TaskProperty Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.GetPropertyByDefinition | ( | TaskPropertyDefinition | 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.Scheduling.TaskProperties.
◆ GetPropertyByDefinitionID()
| TaskProperty Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.GetPropertyByDefinitionID | ( | TaskPropertyDefinitionID | 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.Scheduling.TaskProperties.
◆ GetPropertyByName()
| TaskProperty Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.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.Scheduling.TaskProperties.
◆ TryGetValue() [1/2]
| bool Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.TryGetValue | ( | string | name, |
| out TaskProperty | property | ||
| ) |
Retrieves the property with the specified name.
- Parameters
-
name Name of the property. property A reference to the property with the specified name if exists, null otherwise.
- Returns
- True if property with the specified name exists, False otherwise.
Implemented in Bexel.Api.Scheduling.TaskProperties.
◆ TryGetValue() [2/2]
| bool Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.TryGetValue | ( | TaskPropertyDefinitionID | definitionID, |
| out TaskProperty | property | ||
| ) |
Retrieves the property with the specified definition ID.
- Parameters
-
definitionID Property definition ID of the property. property A reference to the property with the specified property definition ID if exists, null otherwise.
- Returns
- True if property with the specified property definition ID exists, False otherwise.
Implemented in Bexel.Api.Scheduling.TaskProperties.
Property Documentation
◆ this[string name]
|
get |
Retrieves the property with the specified name.
- Parameters
-
name Name of the property.
- Returns
- A property with the specified name.
- Exceptions
-
System.Collections.Generic.KeyNotFoundException No property with the specified name exists within the collection.
◆ this[TaskPropertyDefinitionID 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.
