DisplayAttribute.Description プロパティ

定義

名前空間:

System.ComponentModel.DataAnnotations

アセンブリ:

System.ComponentModel.Annotations.dll

ソース:

DisplayAttribute.cs

UI に説明を表示するために使用される値を取得または設定します。

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

プロパティ値

String

UI に説明を表示するために使用される値。

例

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  

注釈

プロパティの値を取得するには、このプロパティを Description 使用しないでください。 代わりに、GetDescription メソッドを使用してください。

プロパティは Description 通常、この属性を使用してメンバーにバインドされるツールヒントまたは説明 UI 要素として使用されます。 Dynamic Data Edit.ascx テンプレートには、テキスト入力フィールドのヒントとして説明が表示されます。 値または空の null 文字列が有効です。