CodeAnalysisRuleSettings Klasse

Definition

Die Einstellungen zum Konfigurieren von Regeln, die während der Analyse verwendet werden.

Bevor die Analyse beginnt, wird dieses Einstellungsobjekt auf die vom Analysedienst ermittelten Regeln angewendet. Wenn DisableRulesNotInSettings auf "true" festgelegt ist, werden alle Regeln, die nicht in diesen Einstellungen enthalten sind, deaktiviert und während der Analyse nicht ausgeführt.

Diese Einstellungen werden angewendet, indem die ApplySettingsToRules(IEnumerable<RuleConfiguration>) Methode für vom Modul zurückgegebene Regeln aufgerufen wird.

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)
Vererbung
CodeAnalysisRuleSettings
Implementiert

Konstruktoren

Name Beschreibung
CodeAnalysisRuleSettings()

Erstellt ein neues CodeAnalysisRuleSettings-Objekt.

CodeAnalysisRuleSettings(IEnumerable<RuleConfiguration>)

Erstellt einen neuen CodeAnalysisRuleSettings Satz von Regeln.

Eigenschaften

Name Beschreibung
DisableRulesNotInSettings

Sollten regeln in diesen Einstellungen nicht gefunden werden? Der Standardwert ist "false", sodass alle Regeln, die nicht explizit in den Einstellungen behandelt werden, während der Analyse weiterhin ausgeführt werden.

Methoden

Name Beschreibung
Add(RuleConfiguration)

Fügt der Liste der Regeln ein neues RuleConfiguration Objekt hinzu.

ApplySettingsToRules(IEnumerable<RuleConfiguration>)

Wendet diese Einstellungen auf einen anderen Satz von Regeln an.

ConvertToSettingsString()

Konvertiert die Regelkonfigurationsinformationen in diesem CodeAnalysisRuleSettings Objekt in eine Einstellungszeichenfolge wie die, die in SSDT-Projektdateien verwendet wird. Diese Zeichenfolge definiert, welche Regeln deaktiviert werden sollen oder wie ihre Probleme als Fehler behandelt werden sollen, anstelle von Warnungen. Jede Regel, die nicht in der Einstellungszeichenfolge enthalten ist, ist standardmäßig aktiviert.

CreateFromSettingsString(String, IList<ExtensibilityError>)

Erstellt eine CodeAnalysisRuleSettings Konfiguration basierend auf einer Einstellungszeichenfolge wie der in SSDT-Projektdateien verwendeten. Diese Zeichenfolge definiert, welche Regeln deaktiviert werden sollen oder wie ihre Probleme als Fehler behandelt werden sollen, anstelle von Warnungen. Jede Regel, die nicht in der Einstellungszeichenfolge enthalten ist, ist standardmäßig aktiviert.

DisableRule(String)

Schließt eine Regel aus der Ausführung aus.

EnableRule(String)

Enthält eine Regel für die Ausführung

FindConfiguration(String)

Es wird versucht, das RuleConfiguration dem angegebenen ruleIdWert zu entsprechen. Wenn die Konfiguration nicht vorhanden ist, wird NULL zurückgegeben.

GetEnumerator()

GetEnumerator()

IsRuleDisabled(String)

Ist eine bestimmte Regel in den Regeleinstellungen deaktiviert?

IsRuleProblemTreatedAsError(String)

Wird eine bestimmte Regel in den Regeleinstellungen als Fehler behandelt?

Remove(RuleConfiguration)

Entfernt ein RuleConfiguration Objekt aus der Liste der Regeln.

TreatRuleProblemAsError(String)

Behandeln von Problemen, die eine Regel als Fehler gefunden haben

TreatRuleProblemAsWarning(String)

Behandeln von Problemen, die eine Regel als Warnungen gefunden haben

TryGetRuleConfiguration(String, RuleConfiguration)

Es wird versucht, das RuleConfiguration dem angegebenen ruleIdWert zu entsprechen.

Explizite Schnittstellenimplementierungen

Name Beschreibung
IEnumerable.GetEnumerator()

Die Einstellungen zum Konfigurieren von Regeln, die während der Analyse verwendet werden.

Bevor die Analyse beginnt, wird dieses Einstellungsobjekt auf die vom Analysedienst ermittelten Regeln angewendet. Wenn DisableRulesNotInSettings auf "true" festgelegt ist, werden alle Regeln, die nicht in diesen Einstellungen enthalten sind, deaktiviert und während der Analyse nicht ausgeführt.

Diese Einstellungen werden angewendet, indem die ApplySettingsToRules(IEnumerable<RuleConfiguration>) Methode für vom Modul zurückgegebene Regeln aufgerufen wird.

Gilt für: