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

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

Inheritance diagram for Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyDefinitionCollection:
Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection IReadOnlyDictionary

Public Member Functions

bool ContainsKey (TaskPredefinedPropertyType predefinedType)
 Determines whether the collection contains the property definition with the specified predefined property type. More...
 
bool TryGetValue (TaskPredefinedPropertyType predefinedType, out TaskPropertyDefinition definition)
 Retrieves the property definition with the specified predefined property type. More...
 
TaskPropertyDefinition GetPropertyDefinitionByType (TaskPredefinedPropertyType predefinedType)
 Retrieves the property definition with the specified predefined property type. More...
 
- Public Member Functions inherited from Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection
bool ContainsKey (string name)
 Determines whether the collection contains the property definition with the specified name. More...
 
bool TryGetValue (string name, out TaskPropertyDefinition definition)
 Retrieves the property definition with the specified name. More...
 
TaskPropertyDefinition GetPropertyDefinitionByName (string name)
 Retrieves the property definition with the specified name. More...
 
TaskPropertyDefinition GetPropertyDefinitionByID (TaskPropertyDefinitionID id)
 Retrieves the property definition with the specified ID. More...
 

Properties

TaskPropertyDefinition this[TaskPredefinedPropertyType predefinedType] [get]
 Retrieves the property definition with the specified predefined property type. More...
 
- Properties inherited from Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection
TaskPropertyDefinition this[string name] [get]
 Retrieves the property definition with the specified name. More...
 

Detailed Description

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

Member Function Documentation

◆ ContainsKey()

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

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

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

s

◆ GetPropertyDefinitionByType()

TaskPropertyDefinition Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyDefinitionCollection.GetPropertyDefinitionByType ( TaskPredefinedPropertyType  predefinedType)

Retrieves the property definition with the specified predefined property type.

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

◆ TryGetValue()

bool Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyDefinitionCollection.TryGetValue ( TaskPredefinedPropertyType  predefinedType,
out TaskPropertyDefinition  definition 
)

Retrieves the property definition with the specified predefined property type.

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

Property Documentation

◆ this[TaskPredefinedPropertyType predefinedType]

TaskPropertyDefinition Bexel.Api.Scheduling.IReadOnlyTaskPredefinedPropertyDefinitionCollection.this[TaskPredefinedPropertyType predefinedType]
get

Retrieves the property definition with the specified predefined property type.

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