ExportCodeAnalysisRuleAttribute.Description Eigenschaft

Definition

Namespace:

Microsoft.SqlServer.Dac.CodeAnalysis

Assembly:

Microsoft.SqlServer.Dac.Extensions.dll

Paket:

Microsoft.SqlServer.DacFx v162.2.111

Die Beschreibung der Regel. Dies sollte eine kurze lesbare Beschreibung der Regel sein, die vor oder blockieren soll. Dieses Feld ist lokalisierbar, aber dies sollte unterklassig ExportCodeAnalysisRuleAttribute sein und die Description-Eigenschaft überschreiben.

public virtual string Description { get; set; }

member this.Description : string with get, set

Public Overridable Property Description As String

Eigenschaftswert

String

Beispiele

// 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;
        }
    }
}