This documentation is archived and is not being maintained.

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.

ExceptionCondition
InvalidOperationException

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.

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

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: