DisplayAttribute.Description Propriedade

Definição

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Origem:

DisplayAttribute.cs

Obtém ou define um valor usado para exibir uma descrição na interface do usuário.

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

Valor da propriedade

String

Um valor usado para exibir uma descrição na interface do usuário.

Exemplos

O exemplo a seguir mostra como definir a Description propriedade .

[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  

Comentários

Não use essa propriedade para obter o valor da Description propriedade . Use o método GetDescription em seu lugar.

Normalmente Description , a propriedade é usada como uma dica de ferramenta ou elemento de interface do usuário de descrição associado ao membro usando esse atributo. O modelo Edit.ascx de Dados Dinâmicos exibirá a descrição como uma dica de ferramenta em campos de entrada de texto. Um null valor ou cadeia de caracteres vazia é válido.