Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection Interface Reference

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

Inheritance diagram for Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection:

Public Member Functions
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[string name] [get]
	Retrieves the property definition with the specified name. More...

Detailed Description

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

Member Function Documentation

ContainsKey()

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

Implemented in Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.

GetPropertyDefinitionByID()

TaskPropertyDefinition Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection.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.

Implemented in Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.

GetPropertyDefinitionByName()

TaskPropertyDefinition Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection.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.

Implemented in Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.

TryGetValue()

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

Returns

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

Implemented in Bexel.Api.Scheduling.ScheduleTaskPropertyDefinitions.

Property Documentation

this[string name]

TaskPropertyDefinition Bexel.Api.Scheduling.IReadOnlyTaskPropertyDefinitionCollection.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.

Exceptions

System.Collections.Generic.KeyNotFoundException

No property definition with the specified name exists within the collection.