Bexel.Api.Scheduling.TaskProperties Class Reference

Represents a collection of all task properties that are contained within the task. More...

Inheritance diagram for Bexel.Api.Scheduling.TaskProperties:

Public Member Functions
bool	ContainsKey (TaskPropertyDefinition key)
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 (TaskPropertyDefinition key, out TaskProperty value)
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...
IEnumerator< KeyValuePair< TaskPropertyDefinition, TaskProperty > >	GetEnumerator ()

Properties
TaskProperty	this[TaskPropertyDefinition key] [get]
TaskProperty	this[string name] [get]
	Retrieves the property with the specified name. More...
TaskProperty	this[TaskPropertyDefinitionID definitionID] [get]
int	Count [get]
IEnumerable< TaskPropertyDefinition >	Keys [get]
IEnumerable< TaskProperty >	Values [get]
IReadOnlyTaskPredefinedPropertyCollection	Predefined [get]
	Returns a collection of all predefined task properties that are contained within the task. More...
IReadOnlyTaskPropertyCollection	Custom [get]
	Returns a collection of all custom task properties that are contained within the task. 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 collection of all task properties that are contained within the task.

Member Function Documentation

ContainsKey() [1/2]

bool Bexel.Api.Scheduling.TaskProperties.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.

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.

ContainsKey() [2/2]

bool Bexel.Api.Scheduling.TaskProperties.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.

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.

GetPropertyByDefinition()

TaskProperty Bexel.Api.Scheduling.TaskProperties.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.

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.

GetPropertyByDefinitionID()

TaskProperty Bexel.Api.Scheduling.TaskProperties.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.

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.

GetPropertyByName()

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

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.

TryGetValue() [1/2]

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

Returns

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

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.

TryGetValue() [2/2]

bool Bexel.Api.Scheduling.TaskProperties.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.

Implements Bexel.Api.Scheduling.IReadOnlyTaskPropertyCollection.

Property Documentation

Custom

IReadOnlyTaskPropertyCollection Bexel.Api.Scheduling.TaskProperties.Custom

get

Returns a collection of all custom task properties that are contained within the task.

Predefined

IReadOnlyTaskPredefinedPropertyCollection Bexel.Api.Scheduling.TaskProperties.Predefined

get

Returns a collection of all predefined task properties that are contained within the task.

this[string name]

TaskProperty Bexel.Api.Scheduling.TaskProperties.this[string name]

get

Retrieves the property with the specified name.

Parameters

name	Name of the property.

Returns

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

Exceptions

System.Collections.Generic.KeyNotFoundException

No property with the specified name exists within the collection.