FilterAttribute Class

 

Represents the base class for action and result filter attributes.

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

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.OverrideActionFiltersAttribute
      System.Web.Mvc.OverrideAuthenticationAttribute
      System.Web.Mvc.OverrideAuthorizationAttribute
      System.Web.Mvc.OverrideExceptionFiltersAttribute
      System.Web.Mvc.OverrideResultFiltersAttribute
      System.Web.Mvc.RequireHttpsAttribute
      System.Web.Mvc.ValidateAntiForgeryTokenAttribute
      System.Web.Mvc.ValidateInputAttribute

Syntax

[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 : Attribute, IMvcFilter
[<AbstractClass>]
[<AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Method,
    Inherited = true, AllowMultiple = false)>]
type FilterAttribute = 
    class
        inherit Attribute
        interface IMvcFilter
    end
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method,
    Inherited := True, AllowMultiple := False)>
Public MustInherit Class FilterAttribute
    Inherits Attribute
    Implements IMvcFilter

Constructors

Name Description
System_CAPS_protmethod FilterAttribute()

Initializes a new instance of the FilterAttribute class.

Properties

Name Description
System_CAPS_pubproperty AllowMultiple

Gets or sets a value that indicates whether more than one instance of the filter attribute can be specified.

System_CAPS_pubproperty Order

Gets or sets the order in which the action filters are executed.

System_CAPS_pubproperty TypeId

(Inherited from Attribute.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Attribute.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Attribute.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod IsDefaultAttribute()

(Inherited from Attribute.)

System_CAPS_pubmethod Match(Object)

(Inherited from Attribute.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privmethod _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod _Attribute.GetTypeInfoCount(UInt32)

(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

(Inherited from Attribute.)

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 .Unable to find linked topic '30386922-1e00-4602-9ebf-526b271a8b87'.

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

System.Web.Mvc Namespace

Return to top