DisplayAttribute.Description Propriété

Définition

Espace de noms:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Source:

DisplayAttribute.cs

Obtient ou définit une valeur utilisée pour afficher une description dans l'interface utilisateur.

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

Valeur de propriété

String

Valeur utilisée pour afficher une description dans l'interface utilisateur.

Exemples

L'exemple suivant indique comment définir la propriété Description.

[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  

Remarques

N’utilisez pas cette propriété pour obtenir la valeur de la Description propriété . Utilisez plutôt la méthode GetDescription.

La Description propriété est généralement utilisée comme élément d’interface utilisateur d’info-bulle ou de description lié au membre à l’aide de cet attribut. Le modèle Dynamic Data Edit.ascx affiche la description sous forme d’info-bulle dans les champs de saisie de texte. Une null valeur ou une chaîne vide est valide.