FilterAttribute Class

Represents the base class for action and result filter attributes.

Inheritance Hierarchy

System.Object
  System.Attribute
    System.Web.Mvc.FilterAttribute
      System.Web.Mvc.ActionFilterAttribute
      System.Web.Mvc.AuthorizeAttribute
      System.Web.Mvc.ChildActionOnlyAttribute
      System.Web.Mvc.HandleErrorAttribute
      System.Web.Mvc.RequireHttpsAttribute
      System.Web.Mvc.ValidateAntiForgeryTokenAttribute
      System.Web.Mvc.ValidateInputAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, Inherited := True,  _
    AllowMultiple := False)> _
Public MustInherit Class FilterAttribute _
    Inherits Attribute _
    Implements IMvcFilter
'Usage
Dim instance As FilterAttribute
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = true, 
    AllowMultiple = false)]
public abstract class FilterAttribute : Attribute, 
    IMvcFilter
[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, Inherited = true, 
    AllowMultiple = false)]
public ref class FilterAttribute abstract : public Attribute, 
    IMvcFilter
[<AbstractClassAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = true, 
    AllowMultiple = false)>]
type FilterAttribute =  
    class 
        inherit Attribute 
        interface IMvcFilter 
    end
public abstract class FilterAttribute extends Attribute implements IMvcFilter

The FilterAttribute type exposes the following members.

Constructors

  Name Description
Protected method FilterAttribute Initializes a new instance of the FilterAttribute class.

Top

Properties

  Name Description
Public property AllowMultiple Gets or sets a value that indicates whether more than one instance of the filter attribute can be specified.
Public property Order Gets or sets the order in which the action filters are executed.
Public property TypeId (Inherited from Attribute.)

Top

Methods

  Name Description
Public method Equals (Inherited from Attribute.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Attribute.)
Public method GetType (Inherited from Object.)
Public method IsDefaultAttribute (Inherited from Attribute.)
Public method Match (Inherited from Attribute.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method _Attribute.GetIDsOfNames (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfo (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfoCount (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.Invoke (Inherited from Attribute.)

Top

Remarks

Typically, you create a filter by creating an attribute class that inherits from the abstract FilterAttribute class. Some built-in action filters, such as AuthorizeAttribute and HandleErrorAttribute, inherit from the FilterAttribute class. Other action filters, such as OutputCacheAttribute, inherit from the abstract ActionFilterAttribute class, which enables the action filter to run either before or after the action method runs.

You can use filter attributes to mark any action method or controller. If the attribute marks a controller, the filter applies to all action methods in that controller.

For more information about how to use attributes, see Extending Metadata Using Attributes.

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.

See Also

Reference

System.Web.Mvc Namespace