ODataFormattingAttribute Class

Article
10/28/2015

An attribute to be placed on controllers that enables the OData formatters.

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

Inheritance Hierarchy

System.Object
System.Attribute
System.Web.OData.ODataFormattingAttribute

Syntax

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, 
    Inherited = true)]
public class ODataFormattingAttribute : Attribute, IControllerConfiguration

[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = false, 
    Inherited = true)]
public ref class ODataFormattingAttribute : Attribute, IControllerConfiguration

[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false,
    Inherited = true)>]
type ODataFormattingAttribute = 
    class
        inherit Attribute
        interface IControllerConfiguration
    end

<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := False,
    Inherited := True)>
Public Class ODataFormattingAttribute
    Inherits Attribute
    Implements IControllerConfiguration

Constructors

	Name	Description
	ODataFormattingAttribute()

Properties

	Name	Description
	TypeId	(Inherited from Attribute.)

Methods

	Name	Description
	CreateODataFormatters()	Creates the OData formatters.
	Equals(Object)	(Inherited from Attribute.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Attribute.)
	GetType()	(Inherited from Object.)
	Initialize(HttpControllerSettings, HttpControllerDescriptor)	Callback invoked to set per-controller overrides for this controllerDescriptor.
	IsDefaultAttribute()	(Inherited from Attribute.)
	Match(Object)	(Inherited from Attribute.)
	MemberwiseClone()	(Inherited from Object.)
	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

This attribute does the following actions:

[list type="number"] [item] [description] It inserts the ODataMediaTypeFormatters into the [see cref="P:System.Web.Http.Controllers.HttpControllerSettings.Formatters" /] collection. [/description] [/item] [item] [description]It attaches the request to the OData formatter instance.[/description] [/item] [/list]

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