Langage

CodeAnalysisRuleSettings Classe

Définition

Paramètres utilisés pour configurer des règles utilisées pendant l’analyse.

Avant le début de l’analyse, cet objet de paramètres est appliqué aux règles découvertes par le service d’analyse. Si DisableRulesNotInSettings a la valeur true, toutes les règles non incluses dans ces paramètres sont désactivées et ne s’exécutent pas pendant l’analyse.

Ces paramètres sont appliqués en appelant la méthode sur les ApplySettingsToRules(IEnumerable<RuleConfiguration>) règles retournées par le moteur.

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)
Héritage
CodeAnalysisRuleSettings
Implémente

Constructeurs

Nom Description
CodeAnalysisRuleSettings()

Crée un objet CodeAnalysisRuleSettings.

CodeAnalysisRuleSettings(IEnumerable<RuleConfiguration>)

Crée un CodeAnalysisRuleSettings nouvel ensemble de règles contenant un ensemble de règles.

Propriétés

Nom Description
DisableRulesNotInSettings

Les règles non trouvées dans ces paramètres doivent-elles être désactivées ? La valeur par défaut est « false », afin que toutes les règles non explicitement couvertes dans les paramètres soient toujours exécutées pendant l’analyse.

Méthodes

Nom Description
Add(RuleConfiguration)

Ajoute un nouvel RuleConfiguration objet à la liste des règles

ApplySettingsToRules(IEnumerable<RuleConfiguration>)

Applique ces paramètres à un autre ensemble de règles.

ConvertToSettingsString()

Convertit les informations de configuration de règle dans cet CodeAnalysisRuleSettings objet en chaîne de paramètres comme celle utilisée dans les fichiers projet SSDT. Cette chaîne définit quelles règles doivent être désactivées ou avoir leurs problèmes traités comme des erreurs au lieu d’avertissements. Toute règle non incluse dans la chaîne de paramètres est activée par défaut.

CreateFromSettingsString(String, IList<ExtensibilityError>)

Crée une CodeAnalysisRuleSettings configuration basée sur une chaîne de paramètres comme celle utilisée dans les fichiers projet SSDT. Cette chaîne définit quelles règles doivent être désactivées ou avoir leurs problèmes traités comme des erreurs au lieu d’avertissements. Toute règle non incluse dans la chaîne de paramètres est activée par défaut.

DisableRule(String)

Exclut une règle de l’exécution

EnableRule(String)

Inclut une règle pour l’exécution

FindConfiguration(String)

Tente de trouver le RuleConfiguration fichier correspondant à l’élément spécifié ruleId. Si la configuration n’existe pas, la valeur Null est retournée

GetEnumerator()

GetEnumerator()

IsRuleDisabled(String)

Une règle particulière est-elle désactivée dans les paramètres de la règle ?

IsRuleProblemTreatedAsError(String)

Une règle particulière dans les paramètres de la règle est-elle traitée comme une erreur ?

Remove(RuleConfiguration)

Supprime un RuleConfiguration objet de la liste des règles.

TreatRuleProblemAsError(String)

Traiter les problèmes trouvés comme des erreurs

TreatRuleProblemAsWarning(String)

Traiter les problèmes trouvés comme des avertissements

TryGetRuleConfiguration(String, RuleConfiguration)

Tente de trouver le RuleConfiguration fichier correspondant à l’élément spécifié ruleId.

Implémentations d’interfaces explicites

Nom Description
IEnumerable.GetEnumerator()

Paramètres utilisés pour configurer des règles utilisées pendant l’analyse.

Avant le début de l’analyse, cet objet de paramètres est appliqué aux règles découvertes par le service d’analyse. Si DisableRulesNotInSettings a la valeur true, toutes les règles non incluses dans ces paramètres sont désactivées et ne s’exécutent pas pendant l’analyse.

Ces paramètres sont appliqués en appelant la méthode sur les ApplySettingsToRules(IEnumerable<RuleConfiguration>) règles retournées par le moteur.

S’applique à