Export (0) Print
Expand All

FilterableAttribute Class

Specifies whether the property to which the attribute is applied supports device filtering. This class cannot be inherited.

System.Object
  System.Attribute
    System.Web.UI.FilterableAttribute

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Property)> _
Public NotInheritable Class FilterableAttribute _
	Inherits Attribute

The FilterableAttribute type exposes the following members.

  NameDescription
Public methodFilterableAttributeInitializes a new instance of the FilterableAttribute class.
Top

  NameDescription
Public propertyFilterableGets a value indicating whether the property to which the FilterableAttribute attribute is applied supports device filtering.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsInfrastructure. Determines whether the current instance of the FilterableAttribute class is equal to the specified object. (Overrides Attribute.Equals(Object).)
Public methodGetHashCodeInfrastructure. Returns the hash code for this instance. (Overrides Attribute.GetHashCode.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeInfrastructure. Determines whether the current instance of the FilterableAttribute class is equal to the Default attribute. (Overrides Attribute.IsDefaultAttribute.)
Public methodStatic memberIsObjectFilterableDetermines whether the specified Object supports device filtering.
Public methodStatic memberIsPropertyFilterableDetermines whether a property supports device filtering.
Public methodStatic memberIsTypeFilterableDetermines whether the specified data type supports device filtering.
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberDefaultRepresents a predefined FilterableAttribute object with default property settings. This field is read-only.
Public fieldStatic memberNoRepresents a predefined FilterableAttribute object that indicates that a property does not support device filtering. This field is read-only.
Public fieldStatic memberYesRepresents a predefined FilterableAttribute object that indicates that a property supports device filtering. This field is read-only.
Top

  NameDescription
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.)
Top

The FilterableAttribute attribute is applied to a property to specify whether the property supports device filtering. When a property supports device filtering, you can override the value of a property for a specific device by specifying a device filter. By default, properties are filterable, so a control developer could prevent device filtering on a property by setting the FilterableAttribute attribute to false. For more information, see Customizing ASP.NET Mobile Web Controls for Specific Devices.

For more information about using attributes, see Extending Metadata Using Attributes.

For a list of initial property values for an instance of the FilterableAttribute class, see the FilterableAttribute constructor.

The following code example demonstrates how to apply a FilterableAttribute attribute to a property of a custom control to indicate that the property does not support device filtering.


Imports System.ComponentModel
Imports System.Web.UI

Namespace Samples.AspNet.VB.Controls

    Public Class SimpleCustomControl
        Inherits System.Web.UI.WebControls.WebControl

        Dim _productID As String 

        ' Set Filterable attribute to specify that this 
        ' property does not support device filtering.
        <Bindable(True), Filterable(False)> Property ProductID() As String 
            Get 
                Return _productID
            End Get 

            Set(ByVal Value As String)
                _productID = Value
            End Set 
        End Property 
    End Class 

End Namespace

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

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