C# Class Candor.ExecutionResults

Show file Open project: michael-lang/candor-common Class Usage Examples

Public Methods

Method	Description
AppendError ( string message ) : void	Adds a new error to the result.
AppendErrorFormat ( string message ) : void	Adds a new error to the result replacing the format items in the message with the text equivalent of the specified args. Each format specification is replaced by the string representation of the corresponding item in the object argument.
AppendErrors ( StringCollection messages ) : void	Adds new errors to the result.
AppendErrors ( string messages ) : void	Adds new errors to the result.
AppendInfo ( string message ) : void	Adds a new info to the result.
AppendInfoFormat ( string message ) : void	Adds a new info to the result replacing the format items in the message with the text equivalent of the specified args. Each format specification is replaced by the string representation of the corresponding item in the object argument.
AppendInfos ( StringCollection messages ) : void	Adds new infos to the result.
AppendInfos ( string messages ) : void	Adds new infos to the result.
AppendWarning ( string message ) : void	Adds a new warning to the result.
AppendWarningFormat ( string message ) : void	Adds a new warning to the result replacing the format items in the message with the text equivalent of the specified args. Each format specification is replaced by the string representation of the corresponding item in the object argument.
AppendWarnings ( StringCollection messages ) : void	Adds new warnings to the result.
AppendWarnings ( string messages ) : void	Adds new warnings to the result.
Combine ( ExecutionResults results ) : void	Combines the results of another ExecutionResults into this instance.
ExecutionResults ( ) : System	Creates a new instance of ExecutionResults.
Fail ( ) : void	Fails the result without adding a reason why.
Reset ( ) : void	Resets this instance to a successful state and clears all error and warning messages.
ToHtmlString ( ) : string	Outputs the results as an Html string.
ToString ( ) : string	Converts the results of this instance into a single string.
ToString ( string delimeter ) : string	Converts the results of this instance into a single string using the supplied delimeter.
ToString ( string itemFormat, string delimeter ) : string	Converts the results of this instance into a single string using the supplied delimeter.

Method Details

AppendError() public method

Adds a new error to the result.

public AppendError ( string message ) : void
message	string	The error message.
return	void

AppendErrorFormat() public method

Adds a new error to the result replacing the format items in the message with the text equivalent of the specified args. Each format specification is replaced by the string representation of the corresponding item in the object argument.

public AppendErrorFormat ( string message ) : void
message	string	The error message format with zero or /// more format items.
return	void

AppendErrors() public method

Adds new errors to the result.

public AppendErrors ( StringCollection messages ) : void
messages	System.Collections.Specialized.StringCollection	A collection of error messages.
return	void

AppendErrors() public method

Adds new errors to the result.

public AppendErrors ( string messages ) : void
messages	string	An array of error messages.
return	void

AppendInfo() public method

Adds a new info to the result.

public AppendInfo ( string message ) : void
message	string	The info message.
return	void

AppendInfoFormat() public method

Adds a new info to the result replacing the format items in the message with the text equivalent of the specified args. Each format specification is replaced by the string representation of the corresponding item in the object argument.

public AppendInfoFormat ( string message ) : void
message	string	The info message format with zero or /// more format items.
return	void

AppendInfos() public method

Adds new infos to the result.

public AppendInfos ( StringCollection messages ) : void
messages	System.Collections.Specialized.StringCollection	A collection of info messages.
return	void

AppendInfos() public method

Adds new infos to the result.

public AppendInfos ( string messages ) : void
messages	string	An array of info messages.
return	void

AppendWarning() public method

Adds a new warning to the result.

public AppendWarning ( string message ) : void
message	string	The warning message.
return	void

AppendWarningFormat() public method

Adds a new warning to the result replacing the format items in the message with the text equivalent of the specified args. Each format specification is replaced by the string representation of the corresponding item in the object argument.

public AppendWarningFormat ( string message ) : void
message	string	The warning message format with zero or /// more format items.
return	void

AppendWarnings() public method

Adds new warnings to the result.

public AppendWarnings ( StringCollection messages ) : void
messages	System.Collections.Specialized.StringCollection	A collection of warning messages.
return	void

AppendWarnings() public method

Adds new warnings to the result.

public AppendWarnings ( string messages ) : void
messages	string	An array of warning messages.
return	void

Combine() public method

Combines the results of another ExecutionResults into this instance.

public Combine ( ExecutionResults results ) : void
results	ExecutionResults	The results to be combined.
return	void

ExecutionResults() public method

Creates a new instance of ExecutionResults.

public ExecutionResults ( ) : System
return	System

Fail() public method

Fails the result without adding a reason why.

public Fail ( ) : void
return	void

Reset() public method

Resets this instance to a successful state and clears all error and warning messages.

public Reset ( ) : void
return	void

ToHtmlString() public method

Outputs the results as an Html string.

public ToHtmlString ( ) : string
return	string

ToString() public method

Converts the results of this instance into a single string.

public ToString ( ) : string
return	string

ToString() public method

Converts the results of this instance into a single string using the supplied delimeter.

public ToString ( string delimeter ) : string
delimeter	string	Optional, a string to place /// between each execution step. Pass in /// 'null' or an empty string for no delimeter.
return	string

ToString() public method

Converts the results of this instance into a single string using the supplied delimeter.

public ToString ( string itemFormat, string delimeter ) : string
itemFormat	string	The format for each execution step. /// Use '{Message}' in the format string to locate the message. /// Use '{StepType}' in the format string to locate the step type name. /// Do not include any other format specifications /// (IE. '{1}', '{2}', etc...)
delimeter	string	A string to place between each item.
return	string