CodeAnalysisRuleSettings Class

SQL Server 2014

Updated: April 20, 2017

Represents the settings used to configure rules used during analysis. Before analysis begins, this settings object will be applied to the rules discovered by the analysis service. If DisableRule is set to true then any rules not included in these settings will be disabled and not run during analysis.

These settings are applied by calling the ApplySettingsToRules method on rules returned by the engine.

Namespace: Microsoft.SqlServer.Dac.CodeAnalysis
Assembly: Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)

Inheritance Hierarchy

System::Object
Microsoft.SqlServer.Dac.CodeAnalysis::CodeAnalysisRuleSettings

Syntax

C++

public ref class CodeAnalysisRuleSettings sealed : IEnumerable<RuleConfiguration^>, 
	IEnumerable

Constructors

	Name	Description
	CodeAnalysisRuleSettings()
	CodeAnalysisRuleSettings(IEnumerable<RuleConfiguration^>^)

Properties

	Name	Description
	DisableRulesNotInSettings	Determines whether to disable the rules not found in these settings. The default is "false", so that any rules not explicitly covered in the settings will still be run during analysis.

Methods

	Name	Description
	Add(RuleConfiguration^)	Adds a new RuleConfiguration object to the list of rules.
	ApplySettingsToRules(IEnumerable<RuleConfiguration^>^)	Applies these settings to another set of rules.
	ConvertToSettingsString()	Converts the rule configuration info in this CodeAnalysisRuleSettings object into a settings string like the one used inside SSDT project files. This string defines what rules should be disabled or have their problems treated as errors instead of warnings. Any rule not included in the settings string will be enabled by default.
	CreateFromSettingsString(String^, IList<ExtensibilityError^>^%)	Creates a CodeAnalysisRuleSettings configuration based on a settings string like the one used inside SSDT project files. This string defines what rules should be disabled or have their problems treated as errors instead of warnings. Any rule not included in the settings string will be enabled by default.
	DisableRule(String^)	Excludes a rule from execution.
	EnableRule(String^)	Includes a rule for execution.
	Equals(Object^)	(Inherited from Object.)
	FindConfiguration(String^)	Tries to find the RuleConfiguration that matches the specified ruleId. If the configuration doesn't exist then null will be returned.
	GetEnumerator()	Returns an enumerator.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	IsRuleDisabled(String^)	Determines whether a particular rule in the rule settings disabled.
	IsRuleProblemTreatedAsError(String^)	Determines whether a particular rule in the rule settings treated as error.
	Remove(RuleConfiguration^)	Removes a RuleConfiguration object from the list of rules.
	ToString()	(Inherited from Object.)
	TreatRuleProblemAsError(String^)	Treats any problems found a rule as errors.
	TreatRuleProblemAsWarning(String^)	Treats any problems found a rule as warnings.
	TryGetRuleConfiguration(String^, RuleConfiguration^%)	Tries to find the RuleConfiguration that matches the specified ruleId.

Explicit Interface Implementations

	Name	Description
	IEnumerable::GetEnumerator()	Returns an enumerator.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD