C# Class Net.SF.StyleCopCmd.Core.ReportBuilder

This class assists in building a StyleCop report.

Private Properties

Method	Description
Create ( string outputXmlFile ) : void	Creates a StyleCop report.
WithAddInDirectories ( IList addinDirectories ) : ReportBuilder	Includes the following directories in the StyleCop processor's search path for add-ins.
WithDirectories ( IList directories ) : ReportBuilder	Adds directories to check.
WithFiles ( IList files ) : ReportBuilder	Adds files to check.
WithIgnorePatterns ( IList ignorePatterns ) : ReportBuilder	Adds a list of patterns to ignore when checking files.
WithOutputEventHandler ( EventHandler outputEventHandler ) : ReportBuilder	Adds an event handler for when output is generated by the StyleCop processor.
WithProcessorSymbols ( IList processorSymbols ) : ReportBuilder	Adds a list of processor symbols to use when performing the check.
WithProjectFiles ( IList projectFiles ) : ReportBuilder	Adds Visual Studio Project files to check. Visual Studio 2008 is supported.
WithRecursion ( ) : ReportBuilder	Specifies to recurse directories.
WithRecursion ( bool withRecursion ) : ReportBuilder	Specifies to recurse directories.
WithSolutionsFiles ( IList solutionsFiles ) : ReportBuilder	Adds Visual Studio Solution files to check. Visual Studio 2008 is supported.
WithStyleCopSettingsFile ( string styleCopSettingsFile ) : ReportBuilder	Adds a StyleCop settings file to use when performing the check.
WithTransformFile ( string transformFile ) : ReportBuilder	Adds an XSL transform file to use to create an HTML report from the results of the check.

Method	Description
AddDirectory ( string path ) : void	Add the directory's source files to the list of files that StyleCop checks.
AddFile ( string filePath, StyleCopReport solutionsRow, StyleCopReport projectsRow ) : void	Add the given file to the list of files to be checked by StyleCop.
AddProjectFile ( string projectFilePath, StyleCopReport solutionsRow ) : void	Adds a Visual Studio CSharp project file and adds its source files to the list of files to be checked by StyleCop.
AddSolutionFile ( string solutionFilePath ) : void	Adds a Visual Studio solution file and add its CSharp projects to the list of projects to be checked by StyleCop.
GetViolationsFile ( string outputXmlFile ) : string	Gets the path of the violations file to use.
ReportBuilder ( ) : System	Prevents a default instance of the ReportBuilder class from being created.
ReportBuilder ( StyleCopReport report ) : System	Initializes a new instance of the ReportBuilder class.
Transform ( string outputXmlFile ) : void	Transforms the outputted report using an XSL transform file.
ViolationEncountered ( object sender, Microsoft.StyleCop.ViolationEventArgs e ) : void	Callback method for when a violation is encountered.

Creates a StyleCop report.

public Create ( string outputXmlFile ) : void
outputXmlFile	string	/// The fully-qualified path to write the output of the report to. ///
return	void

Includes the following directories in the StyleCop processor's search path for add-ins.

public WithAddInDirectories ( IList addinDirectories ) : ReportBuilder
addinDirectories	IList	The directories to include.
return	ReportBuilder

Adds directories to check.

public WithDirectories ( IList directories ) : ReportBuilder
directories	IList	/// A list of fully-qualifieid paths to directories. ///
return	ReportBuilder

Adds files to check.

public WithFiles ( IList files ) : ReportBuilder
files	IList	/// A list of fully-qualified paths to files. ///
return	ReportBuilder

Adds a list of patterns to ignore when checking files.

public WithIgnorePatterns ( IList ignorePatterns ) : ReportBuilder
ignorePatterns	IList	/// A list of regular expression patterns to ignore when checking /// files. ///
return	ReportBuilder

Adds an event handler for when output is generated by the StyleCop processor.

public WithOutputEventHandler ( EventHandler outputEventHandler ) : ReportBuilder
outputEventHandler	EventHandler	/// The event handler to add. ///
return	ReportBuilder

Adds a list of processor symbols to use when performing the check.

public WithProcessorSymbols ( IList processorSymbols ) : ReportBuilder
processorSymbols	IList	/// A list of processor symboles to use when performing the check. ///
return	ReportBuilder

Adds Visual Studio Project files to check. Visual Studio 2008 is supported.

public WithProjectFiles ( IList projectFiles ) : ReportBuilder
projectFiles	IList	/// A list of fully-qualified paths to Visual Studio project files. ///
return	ReportBuilder

Specifies to recurse directories.

public WithRecursion ( ) : ReportBuilder
return	ReportBuilder

Specifies to recurse directories.

public WithRecursion ( bool withRecursion ) : ReportBuilder
withRecursion	bool	/// True to recurse; otherwise false. ///
return	ReportBuilder

Adds Visual Studio Solution files to check. Visual Studio 2008 is supported.

public WithSolutionsFiles ( IList solutionsFiles ) : ReportBuilder
solutionsFiles	IList	/// A list of fully-qualified paths to Visual Studio solutions files. ///
return	ReportBuilder

Adds a StyleCop settings file to use when performing the check.

public WithStyleCopSettingsFile ( string styleCopSettingsFile ) : ReportBuilder
styleCopSettingsFile	string	/// A fully-qualified path to a StyleCop settings file to use. ///
return	ReportBuilder

Adds an XSL transform file to use to create an HTML report from the results of the check.

public WithTransformFile ( string transformFile ) : ReportBuilder
transformFile	string	/// An XSL transform file to use to create an HTML report from the /// results of the check. ///
return	ReportBuilder