ActionFilterAttribute Class

Article
06/08/2015

Represents the base class for 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.AsyncTimeoutAttribute
        System.Web.Mvc.OutputCacheAttribute

Syntax

[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Method, 
    Inherited = true, AllowMultiple = false)]
public abstract class ActionFilterAttribute : FilterAttribute, 
    IActionFilter, IResultFilter

[AttributeUsageAttribute(AttributeTargets::Class | AttributeTargets::Method, 
    Inherited = true, AllowMultiple = false)]
public ref class ActionFilterAttribute abstract : FilterAttribute, 
    IActionFilter, IResultFilter

[<AbstractClass>]
[<AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Method,
    Inherited = true, AllowMultiple = false)>]
type ActionFilterAttribute = 
    class
        inherit FilterAttribute
        interface IActionFilter
        interface IResultFilter
    end

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method,
    Inherited := True, AllowMultiple := False)>
Public MustInherit Class ActionFilterAttribute
    Inherits FilterAttribute
    Implements IActionFilter, IResultFilter

Constructors

	Name	Description
	ActionFilterAttribute()	Initializes a new instance of the ActionFilterAttribute class.

Properties

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

Methods

	Name	Description
	Equals(Object)	(Inherited from Attribute.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Attribute.)
	GetType()	(Inherited from Object.)
	IsDefaultAttribute()	(Inherited from Attribute.)
	Match(Object)	(Inherited from Attribute.)
	MemberwiseClone()	(Inherited from Object.)
	OnActionExecuted(ActionExecutedContext)	Called by the ASP.NET MVC framework after the action method executes.
	OnActionExecuting(ActionExecutingContext)	Called by the ASP.NET MVC framework before the action method executes.
	OnResultExecuted(ResultExecutedContext)	Called by the ASP.NET MVC framework after the action result executes.
	OnResultExecuting(ResultExecutingContext)	Called by the ASP.NET MVC framework before the action result executes.
	ToString()	(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	(Inherited from Attribute.)
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount(UInt32)	(Inherited from Attribute.)
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	(Inherited from Attribute.)

Remarks

Typically, you create an action or response filter by creating an attribute class that inherits from the abstract ActionFilterAttribute 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.

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.