DisplayAttribute.Description Eigenschaft

Definition

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Quelle:

DisplayAttribute.cs

Ruft einen Wert ab, mit dem eine Beschreibung in der Benutzeroberfläche angezeigt wird, oder legt ihn fest.

public:
 property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };

public string? Description { get; set; }

member this.Description : string with get, set

Public Property Description As String

Eigenschaftswert

String

Der Wert, mit dem eine Beschreibung in der Benutzeroberfläche angezeigt wird.

Beispiele

Im folgenden Beispiel wird das Festlegen der Description-Eigenschaft veranschaulicht.

[MetadataType(typeof(EmployeeMD))]  
public partial class Employee {  
    public class EmployeeMD {  
        [Display(Name = "Last Name", Order = -9,   
        Prompt = "Enter Last Name", Description="Emp Last Name")]  
        public object LastName { get; set; }  

        [Display(Name = "Manager", AutoGenerateFilter=false)]  
        public object Employee1 { get; set; }  
    }  
}  

<MetadataType(GetType(EmployeeMD))>  _  
Public Class Employee  

    Public Class EmployeeMD  

        <Display(Name:="Last Name", Order:=-9, _  
           Prompt:="Enter Last Name", Description:="Emp Last Name")>  _  
        Public Property LastName As Object  
        End Property  

        <Display(Name:="Manager", AutoGenerateFilter:=false)>  _  
        Public Property Employee1 As Object  
        End Property  
    End Class  
End Class  

Hinweise

Verwenden Sie diese Eigenschaft nicht, um den Wert der Description Eigenschaft abzurufen. Verwenden Sie stattdessen die GetDescription-Methode.

Die Description -Eigenschaft wird in der Regel als QuickInfo oder Beschreibungs-UI-Element verwendet, das mithilfe dieses Attributs an das Element gebunden ist. Die Vorlage Dynamic Data Edit.ascx zeigt die Beschreibung als QuickInfo in Texteingabefeldern an. Ein null Wert oder eine leere Zeichenfolge ist gültig.