DisplayAttribute.AutoGenerateFilter Property


Gets or sets a value that indicates whether filtering UI is automatically displayed for this field.

Namespace:   System.ComponentModel.DataAnnotations
Assembly:  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)

public bool AutoGenerateFilter { get; set; }

Property Value

Type: System.Boolean

true if UI should be generated automatically to display filtering for this field; otherwise, false.

Exception Condition

An attempt was made to get the property value before it was set.

Do not use this property to get the value of the AutoGenerateFilter property. Use the GetAutoGenerateFilter method instead.

Setting this property overrides the default behavior for specifying which columns are included as filters.

The following example shows how to disable the filter for the Employee1 field.

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; }

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Available since 3.0
Return to top