DisplayAttribute.AutoGenerateFilter プロパティ

定義

名前空間:

System.ComponentModel.DataAnnotations

アセンブリ:

System.ComponentModel.Annotations.dll

ソース:

DisplayAttribute.cs

このフィールドにフィルター処理の UI が自動的に表示されるかどうかを示す値を取得または設定します。

public:
 property bool AutoGenerateFilter { bool get(); void set(bool value); };

public bool AutoGenerateFilter { get; set; }

member this.AutoGenerateFilter : bool with get, set

Public Property AutoGenerateFilter As Boolean

プロパティ値

Boolean

このフィールドにフィルターを表示する UI を自動的に生成する場合は true。それ以外の場合は false。

例外

InvalidOperationException

プロパティ値を設定する前に取得しようとしました。

例

次の例は、Employee1 フィールドのフィルターを無効にする方法を示しています。

[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  

注釈

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

このプロパティを設定すると、フィルターとして含める列を指定するための既定の動作がオーバーライドされます。