FormUrlEncodedMediaTypeFormatter Class

Article
10/28/2015

MediaTypeFormatter class for handling HTML form URL-ended data, also known as application/x-www-form-urlencoded.

Namespace: System.Net.Http.Formatting
Assembly: System.Net.Http.Formatting (in System.Net.Http.Formatting.dll)

Inheritance Hierarchy

System.Object
System.Net.Http.Formatting.MediaTypeFormatter
System.Net.Http.Formatting.FormUrlEncodedMediaTypeFormatter

Syntax

public class FormUrlEncodedMediaTypeFormatter : MediaTypeFormatter

public ref class FormUrlEncodedMediaTypeFormatter : MediaTypeFormatter

type FormUrlEncodedMediaTypeFormatter = 
    class
        inherit MediaTypeFormatter
    end

Public Class FormUrlEncodedMediaTypeFormatter
    Inherits MediaTypeFormatter

Constructors

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

Properties

	Name	Description
	DefaultMediaType	Gets the default media type for HTML form-URL-encoded data, which is application/x-www-form-urlencoded.
	MaxDepth	Gets or sets the maximum depth allowed by this formatter.
	MediaTypeMappings	Gets the mutable collection of MediaTypeMapping objects that match HTTP requests to media types.(Inherited from MediaTypeFormatter.)
	ReadBufferSize	Gets or sets the size of the buffer when reading the incoming stream.
	RequiredMemberSelector	Gets or sets the IRequiredMemberSelector instance used to determine required members.(Inherited from MediaTypeFormatter.)
	SupportedEncodings	Gets the mutable collection of character encodings supported bythis MediaTypeFormatter.(Inherited from MediaTypeFormatter.)
	SupportedMediaTypes	Gets the mutable collection of media types supported bythis MediaTypeFormatter.(Inherited from MediaTypeFormatter.)

Methods

	Name	Description
	CanReadType(Type)	Queries whether the FormUrlEncodedMediaTypeFormatter can deserializean object of the specified type.(Overrides MediaTypeFormatter.CanReadType(Type).)
	CanWriteType(Type)	Queries whether the FormUrlEncodedMediaTypeFormatter can serializean object of the specified type.(Overrides MediaTypeFormatter.CanWriteType(Type).)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetPerRequestFormatterInstance(Type, HttpRequestMessage, MediaTypeHeaderValue)	Returns a specialized instance of the MediaTypeFormatter that can format a response for the given parameters.(Inherited from MediaTypeFormatter.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ReadFromStreamAsync(Type, Stream, HttpContent, IFormatterLogger)	Asynchronously deserializes an object of the specified type.(Overrides MediaTypeFormatter.ReadFromStreamAsync(Type, Stream, HttpContent, IFormatterLogger).)
	ReadFromStreamAsync(Type, Stream, HttpContent, IFormatterLogger, CancellationToken)	Asynchronously deserializes an object of the specified type.(Inherited from MediaTypeFormatter.)
	SelectCharacterEncoding(HttpContentHeaders)	Determines the best character encoding for reading or writing an HTTP entity body, given a set of content headers.(Inherited from MediaTypeFormatter.)
	SetDefaultContentHeaders(Type, HttpContentHeaders, MediaTypeHeaderValue)	Sets the default headers for content that will be formatted using this formatter. This method is called from the ObjectContent constructor. This implementation sets the Content-Type header to the value of mediaType if it is not null. If it is null it sets the Content-Type to the default media type of this formatter. If the Content-Type does not specify a charset it will set it using this formatters configured Encoding. (Inherited from MediaTypeFormatter.)
	ToString()	(Inherited from Object.)
	WriteToStreamAsync(Type, Object, Stream, HttpContent, TransportContext)	Asynchronously writes an object of the specified type.(Inherited from MediaTypeFormatter.)
	WriteToStreamAsync(Type, Object, Stream, HttpContent, TransportContext, CancellationToken)	Asynchronously writes an object of the specified type.(Inherited from MediaTypeFormatter.)

Extension Methods

	Name	Description
	AddQueryStringMapping(String, String, MediaTypeHeaderValue)	Overloaded. (Defined by MediaTypeFormatterExtensions.)
	AddQueryStringMapping(String, String, String)	Overloaded. (Defined by MediaTypeFormatterExtensions.)
	AddRequestHeaderMapping(String, String, StringComparison, Boolean, MediaTypeHeaderValue)	Overloaded. (Defined by MediaTypeFormatterExtensions.)
	AddRequestHeaderMapping(String, String, StringComparison, Boolean, String)	Overloaded. (Defined by MediaTypeFormatterExtensions.)

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.