CodeAnalysisRuleSettings 类

定义

命名空间:

Microsoft.SqlServer.Dac.CodeAnalysis

程序集:

Microsoft.SqlServer.Dac.Extensions.dll

包:

Microsoft.SqlServer.DacFx v162.2.111

用于配置分析期间使用的规则的设置。

在分析开始之前，此设置对象将应用于分析服务发现的规则。 如果 DisableRulesNotInSettings 设置为 true，则这些设置中不包含的任何规则都将被禁用，并且不会在分析期间运行。

通过对引擎返回的规则调用 ApplySettingsToRules(IEnumerable<RuleConfiguration>) 方法来应用这些设置。

public sealed class CodeAnalysisRuleSettings : System.Collections.Generic.IEnumerable<Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration>

type CodeAnalysisRuleSettings = class
    interface seq<RuleConfiguration>
    interface IEnumerable

Public NotInheritable Class CodeAnalysisRuleSettings
Implements IEnumerable(Of RuleConfiguration)

继承

Object

CodeAnalysisRuleSettings

实现

IEnumerable<RuleConfiguration> IEnumerable

构造函数

名称	说明
CodeAnalysisRuleSettings()	创建新的 CodeAnalysisRuleSettings 对象。
CodeAnalysisRuleSettings(IEnumerable<RuleConfiguration>)	创建一个包含一组规则的新 CodeAnalysisRuleSettings 项。

属性

名称	说明
DisableRulesNotInSettings	是否应禁用这些设置中的规则？ 默认值为“false”，因此，在分析期间，设置中未显式涵盖的任何规则仍将运行。

方法

名称	说明
Add(RuleConfiguration)	将新 RuleConfiguration 对象添加到规则列表中
ApplySettingsToRules(IEnumerable<RuleConfiguration>)	将这些设置应用于另一组规则。
ConvertToSettingsString()	将此 CodeAnalysisRuleSettings 对象中的规则配置信息转换为设置字符串，例如 SSDT 项目文件中使用的设置字符串。 此字符串定义应禁用的规则或将规则视为错误而不是警告。 默认情况下，设置字符串中未包含的任何规则都将启用。
CreateFromSettingsString(String, IList<ExtensibilityError>)	CodeAnalysisRuleSettings基于设置字符串（例如 SSDT 项目文件中使用的设置字符串）创建配置。 此字符串定义应禁用的规则或将规则视为错误而不是警告。 默认情况下，设置字符串中未包含的任何规则都将启用。
DisableRule(String)	从执行中排除规则
EnableRule(String)	包括执行规则
FindConfiguration(String)	尝试查找 RuleConfiguration 与指定的 ruleId匹配项。 如果配置不存在，则将返回 null
GetEnumerator()	GetEnumerator()
IsRuleDisabled(String)	是否禁用规则设置中的特定规则？
IsRuleProblemTreatedAsError(String)	规则设置中的特定规则是否被视为错误？
Remove(RuleConfiguration)	从规则列表中删除对象 RuleConfiguration 。
TreatRuleProblemAsError(String)	将发现规则的任何问题视为错误
TreatRuleProblemAsWarning(String)	将发现规则的任何问题视为警告
TryGetRuleConfiguration(String, RuleConfiguration)	尝试查找 RuleConfiguration 与指定的 ruleId匹配项。

显式接口实现

名称	说明
IEnumerable.GetEnumerator()	用于配置分析期间使用的规则的设置。 在分析开始之前，此设置对象将应用于分析服务发现的规则。 如果 DisableRulesNotInSettings 设置为 true，则这些设置中不包含的任何规则都将被禁用，并且不会在分析期间运行。 通过对引擎返回的规则调用 ApplySettingsToRules(IEnumerable<RuleConfiguration>) 方法来应用这些设置。