Bexel Manager API Documentation
Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyCollection Interface Reference

Represents a read-only collection of predefined Bexel.Api.Scheduling.TaskPropertys. More...

Inheritance diagram for Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyCollection:
Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection IReadOnlyDictionary

Public Member Functions

bool ContainsKey (TaskPredefinedPropertyType predefinedType)
 Determines whether the collection contains the property with the specified predefined property type. More...
 
bool TryGetValue (TaskPredefinedPropertyType predefinedType, out TaskProperty property)
 Retrieves the property with the specified predefined property type. More...
 
TaskProperty GetPropertyByDefinitionType (TaskPredefinedPropertyType predefinedType)
 Retrieves the property with the specified predefined property type. More...
 
- Public Member Functions inherited from Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection
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[TaskPredefinedPropertyType predefinedType] [get]
 Retrieves the property with the specified predefined property type. More...
 
- Properties inherited from Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection
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 predefined Bexel.Api.Scheduling.TaskPropertys.

Member Function Documentation

◆ ContainsKey()

bool Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyCollection.ContainsKey ( TaskPredefinedPropertyType  predefinedType)

Determines whether the collection contains the property with the specified predefined property type.

Parameters
predefinedTypeType of the predefined property.
Returns
True if property with the specified predefined property type exists, False otherwise.

◆ GetPropertyByDefinitionType()

TaskProperty Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyCollection.GetPropertyByDefinitionType ( TaskPredefinedPropertyType  predefinedType)

Retrieves the property with the specified predefined property type.

Parameters
predefinedTypeType of the predefined property.
Returns
A property with the specified predefined property type, null if no such property exists within the collection.

◆ TryGetValue()

bool Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyCollection.TryGetValue ( TaskPredefinedPropertyType  predefinedType,
out TaskProperty  property 
)

Retrieves the property with the specified predefined property type.

Parameters
predefinedTypeType of the predefined property.
propertyA reference to the property with the specified predefined property type if exists, null otherwise.
Returns
True if property with the specified predefined property type exists, False otherwise.

Property Documentation

◆ this[TaskPredefinedPropertyType predefinedType]

TaskProperty Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyCollection.this[TaskPredefinedPropertyType predefinedType]
get

Retrieves the property with the specified predefined property type.

Parameters
predefinedTypeType of the predefined property.
Returns
A property with the specified predefined property type.
Exceptions
System.Collections.Generic.KeyNotFoundExceptionNo property with the specified predefined property type exists within the collection.