This documentation is archived and is not being maintained.

FilterUIHintAttribute Class

Represents an attribute that is used to specify the filtering behavior for a column.


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

<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field, AllowMultiple := False)> _
Public NotInheritable Class FilterUIHintAttribute _
	Inherits Attribute

The FilterUIHintAttribute type exposes the following members.

Public methodFilterUIHintAttribute(String)Initializes a new instance of the FilterUIHintAttribute class by using the filter UI hint.
Public methodFilterUIHintAttribute(String, String)Initializes a new instance of the FilterUIHintAttribute class by using the filter UI hint and presentation layer name.
Public methodFilterUIHintAttribute(String, String, Object())Initializes a new instance of the FilterUIHintAttribute class by using the filter UI hint, presentation layer name, and control parameters.

Public propertyControlParametersGets the name/value pairs that are used as parameters in the control's constructor.
Public propertyFilterUIHintGets the name of the control to use for filtering.
Public propertyPresentationLayerGets the name of the presentation layer that supports this control.
Public propertyTypeIdReturns the unique identifier for this attribute instance. (Overrides Attribute.TypeId.)

Public methodEqualsReturns a value that indicates whether this attribute instance is equal to a specified object. (Overrides Attribute.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this attribute instance. (Overrides Attribute.GetHashCode.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)

The following example shows how to replace default filters on the product entity.

<MetadataType(GetType(Product_MD))>  _
Public Class Product
    Private Class Product_MD
        <FilterUIHint("MultiForeignKey")>  _
        Public Property Category As Object
        End Property
        <FilterUIHint("BooleanRadio")>  _
        Public Property Discontinued As Object
        End Property
    End Class
End Class

.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.