ExportCodeAnalysisRuleAttribute.Description Proprietà

Definizione

Spazio dei nomi:

Microsoft.SqlServer.Dac.CodeAnalysis

Assembly:

Microsoft.SqlServer.Dac.Extensions.dll

Pacchetto:

Microsoft.SqlServer.DacFx v162.2.111

Descrizione della regola. Deve trattarsi di una breve descrizione leggibile dell'avviso o del blocco previsto dalla regola. Questo campo è localizzabile, ma è necessario eseguire la sottoclasse ExportCodeAnalysisRuleAttribute ed eseguire l'override della proprietà Description.

public virtual string Description { get; set; }

member this.Description : string with get, set

Public Overridable Property Description As String

Valore della proprietà

String

Esempio

// Example of an Attribute class that supports localized descriptions:
public class TestLocalizedExportCodeAnalysisRuleAttribute : ExportCodeAnalysisRuleAttribute
{
    private readonly string _descriptionResourceName;
    private string _descriptionValue;

    public TestLocalizedExportCodeAnalysisRuleAttribute(string id, string displayName, string descriptionResourceName)
        : base(id, displayName)
    {
        _descriptionResourceName = descriptionResourceName;
    }

    public override string Description
    {
        get
        {
            if (_descriptionValue == null)
            {
                // Using the descriptionResourceName as the key for looking up the description in the resources file. 
                // MyResources is a resource file in the same project as the LocalizedExportCodeAnalysisRuleAttribute class. 
                // For each rule, and entry should be added to the resources file with the descriptionResourceName as the
                // key and the description as the value
                _descriptionValue = MyResources.ResourceManager.GetString(_descriptionResourceName);
            }
            return _descriptionValue;
        }
    }
}