Crystal.IOptionCollection Interface Reference

Interface to a collection containing T:Crystal.IOptions. More...

Inheritance diagram for Crystal.IOptionCollection:

Public Member Functions
bool	Add (IOption option)
	Adds the specified option to this collection. More...
bool	Contains (string optionId)
	Determines whether this collection contains the option associated with the specified identifier. More...
void	Clear ()
	Clears all T:Crystal.IOptions from this collection. More...
void	ClearAll ()
	Clears all T:Crystal.IOptions from this collection. Additionally all considerations are cleared from P:Crystal.IOptionCollection.Considerations and all actions are cleared from P:Crystal.IOptionCollection.Actions. More...
IOption	Create (string optionId)
	Creates an instance of the option that is associated with the given identifier. If such an option does not exist null is returned.f More...

Properties
IActionCollection	Actions [get]
	The T:Crystal.IActionCollection used to construct this T:Crystal.IOptionCollection.. More...
IConsiderationCollection	Considerations [get]
	The T:Crystal.IConsiderationCollection used to construct this T:Crystal.IOptionCollection.. More...

Detailed Description

Interface to a collection containing T:Crystal.IOptions.

Member Function Documentation

bool Crystal.IOptionCollection.Add

(

IOption

option

)

Adds the specified option to this collection.

Parameters

option

The option.

Returns

true if the T:Crystal.IOption was successfully added to this collection; otherwise, false.

Implemented in Crystal.OptionCollection.

void Crystal.IOptionCollection.Clear

(

)

Clears all T:Crystal.IOptions from this collection.

Implemented in Crystal.OptionCollection.

void Crystal.IOptionCollection.ClearAll

(

)

Clears all T:Crystal.IOptions from this collection. Additionally all considerations are cleared from P:Crystal.IOptionCollection.Considerations and all actions are cleared from P:Crystal.IOptionCollection.Actions.

Implemented in Crystal.OptionCollection.

bool Crystal.IOptionCollection.Contains

(

string

optionId

)

Determines whether this collection contains the option associated with the specified identifier.

Parameters

optionId

The option identifier.

Returns

true if this collection contains an option with the specified identifier; otherwise, false.

Implemented in Crystal.OptionCollection.

IOption Crystal.IOptionCollection.Create

(

string

optionId

)

Creates an instance of the option that is associated with the given identifier. If such an option does not exist null is returned.f

Parameters

optionId

The option identifier.

Implemented in Crystal.OptionCollection.

Property Documentation

IActionCollection Crystal.IOptionCollection.Actions

get

The T:Crystal.IActionCollection used to construct this T:Crystal.IOptionCollection..

IConsiderationCollection Crystal.IOptionCollection.Considerations

get

The T:Crystal.IConsiderationCollection used to construct this T:Crystal.IOptionCollection..

---

The documentation for this interface was generated from the following file:

• Source/Options/Interfaces/IOptionCollection.cs