FilterableAttribute Class

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class FilterableAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Property)]
public sealed class FilterableAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Property)>]
type FilterableAttribute = class
    inherit Attribute

Public NotInheritable Class FilterableAttribute
Inherits Attribute

Inheritance: Object

Attribute
FilterableAttribute

Attributes: AttributeUsageAttribute

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.


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

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 for Specific Devices.

For more information about using attributes, see Attributes.

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

Constructors

FilterableAttribute(Boolean)

Initializes a new instance of the FilterableAttribute class.

Fields

Default	Represents a predefined FilterableAttribute object with default property settings. This field is read-only.
No	Represents a predefined FilterableAttribute object that indicates that a property does not support device filtering. This field is read-only.
Yes	Represents a predefined FilterableAttribute object that indicates that a property supports device filtering. This field is read-only.

Properties

Filterable	Gets a value indicating whether the property to which the FilterableAttribute attribute is applied supports device filtering.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Determines whether the current instance of the FilterableAttribute class is equal to the specified object.
GetHashCode()	Returns the hash code for this instance.
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	Determines whether the current instance of the FilterableAttribute class is equal to the Default attribute.
IsObjectFilterable(Object)	Determines whether the specified Object supports device filtering.
IsPropertyFilterable(PropertyDescriptor)	Determines whether a property supports device filtering.
IsTypeFilterable(Type)	Determines whether the specified data type supports device filtering.
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)

Applies to

Share via