Novell::iFolder::Utility::Option Class Reference

A Command-Line Option. More...

Inheritance diagram for Novell::iFolder::Utility::Option:

[legend]

List of all members.

Public Member Functions
delegate bool	OptionEnteredHandler ()
	Delegate to handle the entered option.
	Option (string names, string title, string description, bool required, string defaultValue)
	Constructor.
void	FromEnvironment (string variable)
	Get the Option Value from the Environment.
override string	ToString ()
	Create a String Representation of the Option.
Protected Attributes
bool	prompt = true
	True if the option should be prompted for.
Properties
string	Name [get]
	The First Option Name.
string[]	Names [get]
	An Array of Option Names.
string	Title [get]
	Get the option title.
string	Description [get, set]
	The Option Description.
bool	Required [get, set]
	Is the Option Required?
string	DefaultValue [get, set]
	The Option Default Value.
bool	Assigned [get, set]
	Has the Option been Assigned?
string	Value [get, set]
	The Option Value.
bool	Prompt [get, set]
	Should we prompt for this option.
OptionEnteredHandler	OnOptionEntered [set]
	Sets the handler for the option.

---

Detailed Description

A Command-Line Option.

---

Constructor & Destructor Documentation

Novell::iFolder::Utility::Option::Option	(	string	names,
		string	title,
		string	description,
		bool	required,
		string	defaultValue
	)			[inline]

Constructor.

Parameters:

	names	A comma-delimited list of option names.
	title	A title for the option.
	description	A description of the option.
	required	Is this option required?
	defaultValue	The option default value;

---

Member Function Documentation

delegate bool Novell::iFolder::Utility::Option::OptionEnteredHandler

(

)

Delegate to handle the entered option.

void Novell::iFolder::Utility::Option::FromEnvironment

(

string

variable

)

[inline]

Get the Option Value from the Environment.

Parameters:

variable

The Environment Variable

override string Novell::iFolder::Utility::Option::ToString

(

)

[inline]

Create a String Representation of the Option.

Returns:

---

Member Data Documentation

bool Novell::iFolder::Utility::Option::prompt = true [protected]

True if the option should be prompted for.

---

Property Documentation

string Novell::iFolder::Utility::Option::Name [get]

The First Option Name.

string [] Novell::iFolder::Utility::Option::Names [get]

An Array of Option Names.

string Novell::iFolder::Utility::Option::Title [get]

Get the option title.

string Novell::iFolder::Utility::Option::Description [get, set]

The Option Description.

bool Novell::iFolder::Utility::Option::Required [get, set]

Is the Option Required?

string Novell::iFolder::Utility::Option::DefaultValue [get, set]

The Option Default Value.

Reimplemented in Novell::iFolder::Utility::BoolOption.

bool Novell::iFolder::Utility::Option::Assigned [get, set]

Has the Option been Assigned?

string Novell::iFolder::Utility::Option::Value [get, set]

The Option Value.

Reimplemented in Novell::iFolder::Utility::BoolOption.

bool Novell::iFolder::Utility::Option::Prompt [get, set]

Should we prompt for this option.

OptionEnteredHandler Novell::iFolder::Utility::Option::OnOptionEntered [set]

Sets the handler for the option.

---

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

• src/server/setup/Options.cs