FilterableAttribute Class
 

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

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

SystemObject
   SystemAttribute
    System.Web.UIFilterableAttribute

[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Property)]
public sealed class FilterableAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class | AttributeTargets::Property)]
public ref class FilterableAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Property)>]
type FilterableAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Property)>
Public NotInheritable Class FilterableAttribute
	Inherits Attribute
NameDescription
System_CAPS_pubmethod FilterableAttribute

Initializes a new instance of the FilterableAttribute class.

NameDescription
System_CAPS_pubproperty

Gets a value indicating whether the property to which the FilterableAttribute attribute is applied supports device filtering.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethod Equals

This API supports the product infrastructure and is not intended to be used directly from your code. Determines whether the current instance of the FilterableAttribute class is equal to the specified object.(Overrides AttributeEquals.)

System_CAPS_pubmethod GetHashCode

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the hash code for this instance.(Overrides AttributeGetHashCode.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod IsDefaultAttribute

This API supports the product infrastructure and is not intended to be used directly from your code. Determines whether the current instance of the FilterableAttribute class is equal to the Default attribute.(Overrides AttributeIsDefaultAttribute.)

System_CAPS_pubmethod System_CAPS_static IsObjectFilterable

Determines whether the specified Object supports device filtering.

System_CAPS_pubmethod System_CAPS_static IsPropertyFilterable

Determines whether a property supports device filtering.

System_CAPS_pubmethod System_CAPS_static IsTypeFilterable

Determines whether the specified data type supports device filtering.

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfield System_CAPS_static Default

Represents a predefined FilterableAttribute object with default property settings. This field is read-only.

System_CAPS_pubfield System_CAPS_static No

Represents a predefined FilterableAttribute object that indicates that a property does not support device filtering. This field is read-only.

System_CAPS_pubfield System_CAPS_static Yes

Represents a predefined FilterableAttribute object that indicates that a property supports device filtering. This field is read-only.

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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


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

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

Return to top