.NET Framework Class Library
FilterableAttribute Class

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

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.UIFilterableAttribute

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)
Syntax
<[%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_0_0_1%].Class Or [%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_0_0_2%].Property)> _
Public NotInheritable Class FilterableAttribute _
	Inherits [%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_1_0_1%].Class|[%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_1_0_2%].Property)]
public sealed class FilterableAttribute : [%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_2_0_1%]::Class|[%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_2_0_2%]::Property)]
public ref class FilterableAttribute sealed : public [%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_3_0_2%].Class|[%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_3_0_3%].Property)>]
type FilterableAttribute =  
    class 
        inherit [%$TOPIC/yzx1tfw4_en-us_VS_110_2_0_3_0_4%] 
    end

The FilterableAttribute type exposes the following members.

Constructors
  NameDescription
Public method FilterableAttributeInitializes a new instance of the FilterableAttribute class.
Top
Properties
  NameDescription
Public property FilterableGets a value indicating whether the property to which the FilterableAttribute attribute is applied supports device filtering.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Determines whether the current instance of the FilterableAttribute class is equal to the specified object. (Overrides AttributeEquals(Object).)
Public method GetHashCodeInfrastructure. Returns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeInfrastructure. Determines whether the current instance of the FilterableAttribute class is equal to the Default attribute. (Overrides AttributeIsDefaultAttribute.)
Public method Static member IsObjectFilterableDetermines whether the specified Object supports device filtering.
Public method Static member IsPropertyFilterableDetermines whether a property supports device filtering.
Public method Static member IsTypeFilterableDetermines whether the specified data type supports device filtering.
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultRepresents a predefined FilterableAttribute object with default property settings. This field is read-only.
Public field Static member NoRepresents a predefined FilterableAttribute object that indicates that a property does not support device filtering. This field is read-only.
Public field Static member YesRepresents a predefined FilterableAttribute object that indicates that a property supports device filtering. This field is read-only.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

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.

Examples

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
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Text;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace Samples.AspNet.CS.Controls
{
    public class SimpleCustomControl : WebControl
    {
        private string _productID;

        // Set Filterable attribute to specify that this 
        // property does not support device filtering.
        [Bindable(true)]
        [Filterable(false)]
        public string ProductID
        {
            get
            {
                return _productID;
            }
            set
            {
                _productID = value;
            }
        }
    }
}
Version Information

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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