XmlMediaTypeFormatter Class

Article
10/28/2015

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

Syntax

public class XmlMediaTypeFormatter : MediaTypeFormatter

public ref class XmlMediaTypeFormatter : MediaTypeFormatter

type XmlMediaTypeFormatter = 
    class
        inherit MediaTypeFormatter
    end

Public Class XmlMediaTypeFormatter
    Inherits MediaTypeFormatter

Constructors

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

Properties

	Name	Description
	DefaultMediaType	Gets the default media type for the XML formatter.
	Indent	Gets or sets a value indicating whether to indent elements when writing data.
	MaxDepth	Gets and sets the maximum nested node depth.
	MediaTypeMappings	Gets the mutable collection of MediaTypeMapping objects that match HTTP requests to media types.(Inherited from MediaTypeFormatter.)
	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.)
	UseXmlSerializer	Gets or sets a value indicating whether the XML formatter uses the XmlSerializer as the default serializer, instead of using the DataContractSerializer.
	WriterSettings	Gets the settings to be used while writing.

Methods

	Name	Description
	CanReadType(Type)	Queries whether the XmlMediaTypeFormatter can deserializean object of the specified type.(Overrides MediaTypeFormatter.CanReadType(Type).)
	CanWriteType(Type)	Queries whether the XmlMediaTypeFormatter can serializean object of the specified type.(Overrides MediaTypeFormatter.CanWriteType(Type).)
	CreateDataContractSerializer(Type)	Called during deserialization to get the DataContractSerializer serializer.
	CreateXmlReader(Stream, HttpContent)	Called during deserialization to get the XML reader to use for reading objects from the stream.
	CreateXmlSerializer(Type)	Called during deserialization to get the XML serializer.
	CreateXmlWriter(Stream, HttpContent)	Called during serialization to get the XML writer to use for writing objects to the stream.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetDeserializer(Type, HttpContent)	Called during deserialization to get the XML serializer to use for deserializing objects.
	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.)
	GetSerializer(Type, Object, HttpContent)	Called during serialization to get the XML serializer to use for serializing objects.
	GetType()	(Inherited from Object.)
	InvokeCreateXmlReader(Stream, HttpContent)	This method is to support infrastructure and is not intended to be used directly from your code.
	InvokeCreateXmlWriter(Stream, HttpContent)	This method is to support infrastructure and is not intended to be used directly from your code.
	InvokeGetDeserializer(Type, HttpContent)	This method is to support infrastructure and is not intended to be used directly from your code.
	InvokeGetSerializer(Type, Object, HttpContent)	This method is to support infrastructure and is not intended to be used directly from your code.
	MemberwiseClone()	(Inherited from Object.)
	ReadFromStreamAsync(Type, Stream, HttpContent, IFormatterLogger)	Called during deserialization to read an object of the specified type from the specified readStream. (Overrides MediaTypeFormatter.ReadFromStreamAsync(Type, Stream, HttpContent, IFormatterLogger).)
	ReadFromStreamAsync(Type, Stream, HttpContent, IFormatterLogger, CancellationToken)	Asynchronously deserializes an object of the specified type.(Inherited from MediaTypeFormatter.)
	RemoveSerializer(Type)	Unregisters the serializer currently associated with the given type.
	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.)
	SetSerializer(Type, XmlObjectSerializer)	Registers an XmlObjectSerializer to read or write objects of a specified type.
	SetSerializer(Type, XmlSerializer)	Registers an XmlSerializer to read or write objects of a specified type.
	SetSerializer<T>(XmlObjectSerializer)	Registers an XmlObjectSerializer to read or write objects of a specified type.
	SetSerializer<T>(XmlSerializer)	Registers an XmlSerializer to read or write objects of a specified type.
	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)	Called during serialization to write an object of the specified type to the specified writeStream.(Overrides MediaTypeFormatter.WriteToStreamAsync(Type, Object, Stream, HttpContent, TransportContext, CancellationToken).)

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.