NDepend.API Documentation
IRule Interface Members
Properties  Methods 

NDepend.Issue Namespace : IRule Interface

The following tables list the members exposed by IRule.

Public Properties
 NameDescription
PropertyCategory Get the rule category.  
PropertyExplicitId The rule explicit-id like "AvoidTypesTooBig" for example.  
PropertyId The rule id like "ND1000" for example.  
PropertyIsCritical Is the rule considered critical or not.  
PropertyName The rule name.  
PropertyProvider The rule provider.  
Top
Public Methods
 NameDescription
MethodTryGetDescriptionTry get the rule description if available, formatted according to stringFormattingKind.  
MethodTryGetHowToFixTry get how-to-fix-rule explanation if available, formatted according to stringFormattingKind.  
Top
Extension Methods
 NameDescription
Public Extension MethodAnnualInterestOverloaded. Gets the summed annual-interest of all issues of rule.
Public Extension MethodAnnualInterestDiffOverloaded. Gets NewerIssuesSet.AnnualInterest(IRule) of NewerVersion(IRule) of rule, minus OlderIssuesSet.AnnualInterest(IRule) of OlderVersion(IRule) of rule.
Public Extension MethodAnnualInterestPercentOverloaded. Gets NDepend.TechnicalDebt.ExtensionMethodsDebtUsableInCQLinq.NDepend.TechnicalDebt.ExtensionMethodsDebtUsableInCQLinq.AnnualInterestPercent(Debt(IRule),AnnualInterest(IRule)).
Public Extension MethodAnnualInterestPercentDiffOverloaded. Gets NDepend.TechnicalDebt.ExtensionMethodsDebtUsableInCQLinq.NDepend.TechnicalDebt.ExtensionMethodsDebtUsableInCQLinq.AnnualInterestPercent(DebtDiff(IRule),AnnualInterestDiff(IRule)).
Public Extension MethodBreakingPointOverloaded. Gets NDepend.TechnicalDebt.ExtensionMethodsDebtUsableInCQLinq.NDepend.TechnicalDebt.ExtensionMethodsDebtUsableInCQLinq.BreakingPoint(Debt(IRule),AnnualInterest(IRule)).
Public Extension MethodBreakingPointDiffOverloaded. Gets NDepend.TechnicalDebt.ExtensionMethodsDebtUsableInCQLinq.NDepend.TechnicalDebt.ExtensionMethodsDebtUsableInCQLinq.BreakingPoint(DebtDiff(IRule),AnnualInterestDiff(IRule)).
Public Extension MethodDebtOverloaded. Gets the summed debt of all issues of rule.
Public Extension MethodDebtDiffOverloaded. Gets NewerIssuesSet.Debt(IRule) of NewerVersion(IRule) of rule, minus OlderIssuesSet.Debt(IRule) of OlderVersion(IRule) of rule.
Public Extension MethodGetIssuesOverloaded. Gets issues of rule from queryExecutionSuccessResult.
Public Extension MethodIsInNewerIssuesSetOverloaded. Gets a value that indicates if qualityGate is in NewerIssuesSet.
Public Extension MethodIsInOlderIssuesSetOverloaded. Gets a value that indicates if qualityGate is in OlderIssuesSet.
Public Extension MethodIsNotViolatedAnymoreGets a value that indicates if rule is present in both NewerIssuesSet and OlderIssuesSet and is violated in OlderIssuesSet and not in NewerIssuesSet.
Public Extension MethodIsPresentInBothIssuesSetOverloaded. Gets a value that indicates if qualityGate is in NewerIssuesSet or OlderIssuesSet and has an equivalent in the other issues-set.
Public Extension MethodIssuesOverloaded. Gets all issues of rule.
Public Extension MethodIssuesAddedOverloaded. Gets all issues of rule that have no equivalent in OlderIssuesSet. These issues are considered as added.
Public Extension MethodIssuesFixedOverloaded. Gets all issues of rule that have no equivalent in NewerIssuesSet. These issues are considered as fixed.
Public Extension MethodIsViolatedGets a value that indicates if the rule is violated in the context of this issues-set.
Public Extension MethodNewerVersionOverloaded. Gets the qualityGate in NewerIssuesSet, or null if qualityGate has no equivalent in NewerIssuesSet.
Public Extension MethodOlderVersionOverloaded. Gets the qualityGate in OlderIssuesSet, or null if qualityGate has no equivalent in OlderIssuesSet.
Public Extension MethodWasNotViolatedAndIsViolatedGets a value that indicates if rule is present in both NewerIssuesSet and OlderIssuesSet and is violated in NewerIssuesSet and not in OlderIssuesSet.
Top
See Also

Reference

IRule Interface
NDepend.Issue Namespace

Send Feedback