NDepend.API Documentation
IProject Interface Members
Properties  Methods  Events

NDepend.Project Namespace : IProject Interface

The following tables list the members exposed by IProject.

Public Properties
 NameDescription
PropertyBaselineDuringAnalysis Represents settings of this NDepend project concerning the baseline eventually used during analysis.  
PropertyBaselineInUI Represents settings of this NDepend project concerning the baseline eventually used in NDepend user interface (VisualNDepend or VisualStudio addin).  
PropertyCodeQueries Represents this NDepend project code queries and code rules.  
PropertyCodeToAnalyze Represents this NDepend project assemblies to analyze.  
PropertyCoverage Represents settings of this NDepend project concerning code coverage file(s) to load to obtain code coverage metrics.  
PropertyDebtSettings Represents the debt settings of this project.  
PropertyDisabledWarnings Represents the collection of analysis warnings disabled, of this NDepend project.  
PropertyGithub Represents this NDepend project Github settings.  
PropertyGraphFiles Represents the list of graph files referenced by this project.  
PropertyHistoricAnalysisResult Represents this NDepend project's settings relative to Historic Analysis Results storage.  
PropertyPathVariables Represents this NDepend project path variables collection.  
PropertyProperties Represents this NDepend project main properties.  
PropertyReport Represents settings of this NDepend project concerning report.  
PropertyRuleFiles Represents the list of rule files referenced by this project.  
PropertySourceFilesRebasing Represents this NDepend project source files rebasing settings.  
PropertyTrend Represents this NDepend project's settings relative to trend metrics log and diagrams displayed.  
Top
Public Methods
 NameDescription
MethodGetProjectRefGets a reference to this NDepend project, with IProjectRef.IProjectRef.DateLastTouched equals to dateLastTouched.  
Top
Extension Methods
 NameDescription
Public Extension MethodBuildAnalysisResultRefForCreate an IAnalysisResultRef object from a project, an analysis result file (.ndar extension) and a date.
Public Extension MethodCanAllPathsReferencedBeResolvedAsAbsoluteThis method returns a list of string, that each describes in plain-english, the failure to resolve as absolute a path referenced by project. The list returned is empty if all paths can be resolved as absolute.
Public Extension MethodGetAvailableAnalysisResultsRefsGets a collection of all analysis results available for this project ordered by IAnalysisResultRef. descending.
Public Extension MethodGetAvailableAnalysisResultsRefsGroupedPerMonthGets a collection of all analysis results available for this project, grouped per months.
Public Extension MethodGetDefaultOutputDirectoryAbsolutePath Gets the output directory absolute path that is used during the analysis if the project output directory provided is not an absolute path and cannot be resolved.
Public Extension MethodGetOutputDirectoryAbsolutePath Gets the output directory absolute path that is used during the analysis.
Public Extension MethodGetRulesInProjectFileAndInRuleFiles Try get rules and queries declared in the project file and in rule files referenced by the project.
Public Extension MethodGetRulesInProjectFileAndInRuleFilesAndDeclaredInSourceCode Try get rules and queries declared in the project file, in rule files referenced by the project and in source code.
Public Extension MethodLoadAnalysisResultFromFile Loads the analysis result of a project from an analysis result file (.ndar extension).
Public Extension MethodLogTrendMetricsOverloaded. Force log trend metrics values for this analysisResult.
Public Extension MethodRunAnalysisOverloaded.  Runs a full analysis on this project, in-process and synchronously. (Only available with a Build Machine license).
Public Extension MethodRunAnalysisAndBuildReportOverloaded.  Runs a full analysis on this project, in-process and synchronously, and then generate a HTML report. (Only available with a Build Machine license).
Public Extension MethodTryComputeLogLabelTry compute the log label from project and codeBase.
Public Extension MethodTryGetMostRecentAnalysisResultRefGets a reference to the most recent analysis result available for this project.
Public Extension MethodTryLoadRuleFileOverloaded. Try load code rules and queries defined in the rule file defined by ruleFileRef.
Public Extension MethodTryResolveAbsolutePathFromProjectOverloaded. This method attempts to resolve an absolute file path from a file path
Public Extension MethodTrySaveRuleFileOverloaded. Try save code rules and queries defined in a rule file defined by ruleFileRef.
Top
Public Events
 NameDescription
EventSettingsChanged This event is triggered each time some settings of this NDepend project are changed.  
Top
See Also

Reference

IProject Interface
NDepend.Project Namespace

Send Feedback