WebApiEnabledAttribute Class

Article
06/08/2015

Represents the attribute indicating that the controller supports multiple formats (HTML, XML, JSON etc), HTTP method based dispatch and HTTP error handling.

Namespace: Microsoft.Web.Mvc.Resources
Assembly: Microsoft.Web.Mvc (in Microsoft.Web.Mvc.dll)

Inheritance Hierarchy

System.Object
  System.Attribute
    System.Web.Mvc.FilterAttribute
      System.Web.Mvc.ActionFilterAttribute
        Microsoft.Web.Mvc.Resources.WebApiEnabledAttribute

Syntax

[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Method, 
    Inherited = true, AllowMultiple = false)]
public class WebApiEnabledAttribute : ActionFilterAttribute, 
    IExceptionFilter

[AttributeUsageAttribute(AttributeTargets::Class | AttributeTargets::Method, 
    Inherited = true, AllowMultiple = false)]
public ref class WebApiEnabledAttribute : ActionFilterAttribute, 
    IExceptionFilter

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

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method,
    Inherited := True, AllowMultiple := False)>
Public Class WebApiEnabledAttribute
    Inherits ActionFilterAttribute
    Implements IExceptionFilter

Constructors

	Name	Description
	WebApiEnabledAttribute()	Initializes a new instance of the WebApiEnabledAttribute 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.)
	StatusOnNullModel	Gets or sets the HTTP status code to use in case a null value is returned from the controller action method. The default is NotFound.
	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.)
	IsDefined(ControllerBase)	Returns a value that indicates whether the specified controller is defined on this member.
	Match(Object)	(Inherited from Attribute.)
	MemberwiseClone()	(Inherited from Object.)
	OnActionExecuted(ActionExecutedContext)	Called by the ASP.NET MVC framework after the action method executes.(Overrides ActionFilterAttribute.OnActionExecuted(ActionExecutedContext).)
	OnActionExecuting(ActionExecutingContext)	Called by the ASP.NET MVC framework before the action method executes.(Inherited from ActionFilterAttribute.)
	OnException(ExceptionContext)	Raises the exception event.
	OnResultExecuted(ResultExecutedContext)	Called by the ASP.NET MVC framework after the action result executes.(Inherited from ActionFilterAttribute.)
	OnResultExecuting(ResultExecutingContext)	Called by the ASP.NET MVC framework before the action result executes.(Inherited from ActionFilterAttribute.)
	ToString()	(Inherited from Object.)
	TryGetErrorResult(HttpException, ContentType, ResourceErrorActionResult)	Returns true if the specified exception, response format and action result will get an error result.
	TryGetResult(ViewResultBase, ContentType, MultiFormatActionResult)	Returns true if the specified view result, response format and action result will get a result.

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

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.

Share via