Represents a collection of all task property definitions that are contained within the schedule. More...

Inheritance diagram for Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions:

Public Member Functions
bool	ContainsKey (TaskPropertyDefinitionID key)

bool	ContainsKey (string name)
	Determines whether the collection contains the property definition with the specified name. More...

bool	TryGetValue (TaskPropertyDefinitionID key, out TaskPropertyDefinition value)

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...

IEnumerator< KeyValuePair< TaskPropertyDefinitionID, TaskPropertyDefinition > >	GetEnumerator ()

Properties
TaskPropertyDefinition	this[TaskPropertyDefinitionID key] `[get]`

TaskPropertyDefinition	this[string name] `[get]`
	Retrieves the property definition with the specified name. More...

IEnumerable< TaskPropertyDefinitionID >	Keys `[get]`

IEnumerable< TaskPropertyDefinition >	Values `[get]`

int	Count `[get]`

IReadOnlyTaskPredefinedPropertyDefinitionCollection	Predefined `[get]`
	Returns a collection of all predefined task property definitions that are contained within the schedule. More...

IReadOnlyTaskPropertyDefinitionCollection	Custom `[get]`
	Returns a collection of all custom task property definitions that are contained within the schedule. 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 collection of all task property definitions that are contained within the schedule.

Member Function Documentation

◆ ContainsKey()

bool Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.ContainsKey ( string name )

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

Parameters

name	Name of the property definition.

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

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection.

◆ GetPropertyDefinitionByID()

TaskPropertyDefinition Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.GetPropertyDefinitionByID ( TaskPropertyDefinitionID 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.

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection.

◆ GetPropertyDefinitionByName()

TaskPropertyDefinition Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.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. If a property definition with the same name exists within the custom task property definitions and the predefined task property definitions collection, the predefined task property definition will be returned.

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection.

◆ TryGetValue()

bool Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.TryGetValue	(	string	name,
		out TaskPropertyDefinition	definition
	)

Retrieves the property definition with the specified name.

Parameters

name	Name of the property definition.
definition	A reference to the property definition with the specified name if exists, null otherwise. If a property definition with the same name exists within the custom task property definitions and the predefined task property definitions collection, the predefined task property definition will be returned.

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

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection.

Property Documentation

◆ Custom

IReadOnlyTaskPropertyDefinitionCollection Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.Custom

get

Returns a collection of all custom task property definitions that are contained within the schedule.

◆ Predefined

IReadOnlyTaskPredefinedPropertyDefinitionCollection Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.Predefined

get

Returns a collection of all predefined task property definitions that are contained within the schedule.

◆ this[string name]

TaskPropertyDefinition Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.this[string name]

get

Retrieves the property definition with the specified name.

Parameters

name	Name of the property definition.

Returns: A property definition with the specified name. If a property definition with the same name exists within the custom task property definitions and the predefined task property definitions collection, the predefined task property definition will be returned.

Exceptions

System.Collections.Generic.KeyNotFoundException No property with the specified name exists within the collection.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ContainsKey()

◆ GetPropertyDefinitionByID()

◆ GetPropertyDefinitionByName()

◆ TryGetValue()

Property Documentation

◆ Custom

◆ Predefined

◆ this[string name]