0 out of 4 rated this helpful - Rate this topic

XmlDictionaryWriter Class

An abstract class that the derives from to do serialization and deserialization.

System.Object
  System.Xml.XmlWriter
    System.Xml.XmlDictionaryWriter

Namespace:  System.Xml
Assembly:  System.Runtime.Serialization (in System.Runtime.Serialization.dll)
public abstract class XmlDictionaryWriter : XmlWriter

The XmlDictionaryWriter type exposes the following members.

  Name Description
Protected method Supported by Portable Class Library XmlDictionaryWriter Creates an instance of this class. Invoked only by its derived classes because this class is abstract.
Top
  Name Description
Public property Supported by Portable Class Library CanCanonicalize This property always returns false. Its derived classes can override to return true if they support canonicalization.
Public property Supported by Portable Class Library Settings Gets the XmlWriterSettings object used to create this XmlWriter instance. (Inherited from XmlWriter.)
Public property Supported by Portable Class Library WriteState When overridden in a derived class, gets the state of the writer. (Inherited from XmlWriter.)
Public property Supported by Portable Class Library XmlLang When overridden in a derived class, gets the current xml:lang scope. (Inherited from XmlWriter.)
Public property Supported by Portable Class Library XmlSpace When overridden in a derived class, gets an XmlSpace representing the current xml:space scope. (Inherited from XmlWriter.)
Top
  Name Description
Public method Close When overridden in a derived class, closes this stream and the underlying stream. (Inherited from XmlWriter.)
Public method Static member Supported by Portable Class Library CreateBinaryWriter(Stream) Creates an instance of XmlDictionaryWriter that writes binary XML format.
Public method Static member Supported by Portable Class Library CreateBinaryWriter(Stream, IXmlDictionary) Creates an instance of XmlDictionaryWriter that writes binary XML format.
Public method Static member Supported by Portable Class Library CreateBinaryWriter(Stream, IXmlDictionary, XmlBinaryWriterSession) Creates an instance of XmlDictionaryWriter that writes binary XML format.
Public method Static member Supported by Portable Class Library CreateBinaryWriter(Stream, IXmlDictionary, XmlBinaryWriterSession, Boolean) Creates an instance of XmlDictionaryWriter that writes binary XML format.
Public method Static member Supported by Portable Class Library CreateDictionaryWriter Creates an instance of XmlDictionaryWriter from an existing XmlWriter.
Public method Static member CreateMtomWriter(Stream, Encoding, Int32, String) Creates an instance of XmlDictionaryWriter that writes XML in the MTOM format.
Public method Static member CreateMtomWriter(Stream, Encoding, Int32, String, String, String, Boolean, Boolean) Creates an instance of XmlDictionaryWriter that writes XML in the MTOM format.
Public method Static member CreateTextWriter(Stream) Creates an instance of XmlDictionaryWriter that writes text XML.
Public method Static member CreateTextWriter(Stream, Encoding) Creates an instance of XmlDictionaryWriter that writes text XML.
Public method Static member CreateTextWriter(Stream, Encoding, Boolean) Creates an instance of XmlDictionaryWriter that writes text XML.
Public method Supported by Portable Class Library Dispose() (Inherited from XmlWriter.)
Protected method Supported by Portable Class Library Dispose(Boolean) Releases the unmanaged resources used by the XmlWriter and optionally releases the managed resources. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library EndCanonicalization This method is not yet implemented.
Public method Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by Portable Class Library Flush When overridden in a derived class, flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Supported by Portable Class Library LookupPrefix When overridden in a derived class, returns the closest prefix defined in the current namespace scope for the namespace URI. (Inherited from XmlWriter.)
Protected method Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by Portable Class Library StartCanonicalization This method is not yet implemented.
Public method Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Supported by Portable Class Library WriteArray(String, String, String, Boolean[], Int32, Int32) Writes values from a Boolean array.
Public method Supported by Portable Class Library WriteArray(String, String, String, DateTime[], Int32, Int32) Writes nodes from a DateTime array.
Public method Supported by Portable Class Library WriteArray(String, String, String, Decimal[], Int32, Int32) Writes nodes from a Decimal array.
Public method Supported by Portable Class Library WriteArray(String, String, String, Double[], Int32, Int32) Writes nodes from a Double array.
Public method Supported by Portable Class Library WriteArray(String, String, String, Guid[], Int32, Int32) Writes nodes from a Guid array.
Public method Supported by Portable Class Library WriteArray(String, String, String, Int16[], Int32, Int32) Writes nodes from a Int16 array.
Public method Supported by Portable Class Library WriteArray(String, String, String, Int32[], Int32, Int32) Writes nodes from a Int32 array.
Public method Supported by Portable Class Library WriteArray(String, String, String, Int64[], Int32, Int32) Writes nodes from a Int64 array.
Public method Supported by Portable Class Library WriteArray(String, String, String, Single[], Int32, Int32) Writes nodes from a Single array.
Public method Supported by Portable Class Library WriteArray(String, String, String, TimeSpan[], Int32, Int32) Writes nodes from a TimeSpan array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, Boolean[], Int32, Int32) Writes nodes from a Boolean array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, DateTime[], Int32, Int32) Writes nodes from a DateTime array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, Decimal[], Int32, Int32) Writes nodes from a Decimal array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, Double[], Int32, Int32) Writes nodes from a Double array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, Guid[], Int32, Int32) Writes nodes from a Guid array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, Int16[], Int32, Int32) Writes nodes from a Int16 array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, Int32[], Int32, Int32) Writes nodes from a Int32 array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, Int64[], Int32, Int32) Writes nodes from a Int64 array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, Single[], Int32, Int32) Writes nodes from a Single array.
Public method Supported by Portable Class Library WriteArray(String, XmlDictionaryString, XmlDictionaryString, TimeSpan[], Int32, Int32) Writes nodes from a TimeSpan array.
Public method Supported by Portable Class Library WriteAttributes When overridden in a derived class, writes out all the attributes found at the current position in the XmlReader. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteAttributeString(String, String) When overridden in a derived class, writes out the attribute with the specified local name and value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteAttributeString(String, String, String) When overridden in a derived class, writes an attribute with the specified local name, namespace URI, and value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteAttributeString(XmlDictionaryString, XmlDictionaryString, String) Writes an attribute qualified name and value.
Public method Supported by Portable Class Library WriteAttributeString(String, XmlDictionaryString, XmlDictionaryString, String) Writes an attribute qualified name and value.
Public method Supported by Portable Class Library WriteAttributeString(String, String, String, String) When overridden in a derived class, writes out the attribute with the specified prefix, local name, namespace URI, and value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteBase64 When overridden in a derived class, encodes the specified binary bytes as Base64 and writes out the resulting text. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteBinHex When overridden in a derived class, encodes the specified binary bytes as BinHex and writes out the resulting text. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteCData When overridden in a derived class, writes out a <![CDATA[...]]> block containing the specified text. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteCharEntity When overridden in a derived class, forces the generation of a character entity for the specified Unicode character value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteChars When overridden in a derived class, writes text one buffer at a time. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteComment When overridden in a derived class, writes out a comment <!--...--> containing the specified text. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteDocType When overridden in a derived class, writes the DOCTYPE declaration with the specified name and optional attributes. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteElementString(String, String) Writes an element with the specified local name and value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteElementString(String, String, String) Writes an element with the specified local name, namespace URI, and value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteElementString(XmlDictionaryString, XmlDictionaryString, String) Writes an element with a text content.
Public method Supported by Portable Class Library WriteElementString(String, XmlDictionaryString, XmlDictionaryString, String) Writes an element with a text content.
Public method Supported by Portable Class Library WriteElementString(String, String, String, String) Writes an element with the specified local name, namespace URI, and value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteEndAttribute When overridden in a derived class, closes the previous WriteStartAttribute call. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteEndDocument When overridden in a derived class, closes any open elements or attributes and puts the writer back in the Start state. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteEndElement When overridden in a derived class, closes one element and pops the corresponding namespace scope. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteEntityRef When overridden in a derived class, writes out an entity reference as &name;. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteFullEndElement When overridden in a derived class, closes one element and pops the corresponding namespace scope. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteName When overridden in a derived class, writes out the specified name, ensuring it is a valid name according to the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name). (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteNmToken When overridden in a derived class, writes out the specified name, ensuring it is a valid NmToken according to the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name). (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteNode(XmlDictionaryReader, Boolean) Writes the current XML node from an XmlDictionaryReader.
Public method Supported by Portable Class Library WriteNode(XmlReader, Boolean) Writes the current XML node from an XmlReader. (Overrides XmlWriter.WriteNode(XmlReader, Boolean).)
Public method WriteNode(XPathNavigator, Boolean) Copies everything from the XPathNavigator object to the writer. The position of the XPathNavigator remains unchanged. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteProcessingInstruction When overridden in a derived class, writes out a processing instruction with a space between the name and text as follows: <?name text?>. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteQualifiedName(String, String) When overridden in a derived class, writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteQualifiedName(XmlDictionaryString, XmlDictionaryString) Writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace.
Public method Supported by Portable Class Library WriteRaw(String) When overridden in a derived class, writes raw markup manually from a string. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteRaw(Char[], Int32, Int32) When overridden in a derived class, writes raw markup manually from a character buffer. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteStartAttribute(String) Writes the start of an attribute with the specified local name. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteStartAttribute(String, String) Writes the start of an attribute with the specified local name and namespace URI. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteStartAttribute(XmlDictionaryString, XmlDictionaryString) Writes the start of an attribute with the specified local name, and namespace URI.
Public method Supported by Portable Class Library WriteStartAttribute(String, XmlDictionaryString, XmlDictionaryString) Writes the start of an attribute with the specified prefix, local name, and namespace URI.
Public method Supported by Portable Class Library WriteStartAttribute(String, String, String) When overridden in a derived class, writes the start of an attribute with the specified prefix, local name, and namespace URI. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteStartDocument() When overridden in a derived class, writes the XML declaration with the version "1.0". (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteStartDocument(Boolean) When overridden in a derived class, writes the XML declaration with the version "1.0" and the standalone attribute. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteStartElement(String) When overridden in a derived class, writes out a start tag with the specified local name. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteStartElement(String, String) When overridden in a derived class, writes the specified start tag and associates it with the given namespace. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteStartElement(XmlDictionaryString, XmlDictionaryString) Writes the specified start tag and associates it with the given namespace.
Public method Supported by Portable Class Library WriteStartElement(String, XmlDictionaryString, XmlDictionaryString) Writes the specified start tag and associates it with the given namespace and prefix.
Public method Supported by Portable Class Library WriteStartElement(String, String, String) When overridden in a derived class, writes the specified start tag and associates it with the given namespace and prefix. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteString(String) When overridden in a derived class, writes the given text content. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteString(XmlDictionaryString) Writes the given text content.
Public method Supported by Portable Class Library WriteSurrogateCharEntity When overridden in a derived class, generates and writes the surrogate character entity for the surrogate character pair. (Inherited from XmlWriter.)
Protected method Supported by Portable Class Library WriteTextNode Writes the text node that an XmlDictionaryReader is currently positioned on.
Public method Supported by Portable Class Library WriteValue(Boolean) Writes a Boolean value. (Inherited from XmlWriter.)
Public method WriteValue(DateTime) Writes a DateTime value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteValue(Decimal) Writes a Decimal value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteValue(Double) Writes a Double value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteValue(Guid) Writes a Guid value.
Public method Supported by Portable Class Library WriteValue(Int32) Writes a Int32 value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteValue(Int64) Writes a Int64 value. (Inherited from XmlWriter.)
Public method WriteValue(IStreamProvider) Writes a value from an IStreamProvider.
Public method Supported by Portable Class Library WriteValue(Object) Writes the object value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteValue(Single) Writes a single-precision floating-point number. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteValue(String) Writes a String value. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteValue(TimeSpan) Writes a TimeSpan value.
Public method Supported by Portable Class Library WriteValue(UniqueId) Writes a Unique Id value.
Public method Supported by Portable Class Library WriteValue(XmlDictionaryString) Writes a XmlDictionaryString value.
Public method Supported by Portable Class Library WriteWhitespace When overridden in a derived class, writes out the given white space. (Inherited from XmlWriter.)
Public method Supported by Portable Class Library WriteXmlAttribute(String, String) Writes a standard XML attribute in the current node.
Public method Supported by Portable Class Library WriteXmlAttribute(XmlDictionaryString, XmlDictionaryString) Writes an XML attribute in the current node.
Public method Supported by Portable Class Library WriteXmlnsAttribute(String, String) Writes a namespace declaration attribute.
Public method Supported by Portable Class Library WriteXmlnsAttribute(String, XmlDictionaryString) Writes a namespace declaration attribute.
Top
  Name Description
Explicit interface implemetation Private method IDisposable.Dispose For a description of this member, see IDisposable.Dispose. (Inherited from XmlWriter.)
Top

You can derive from this class to do other functions than serialization.

Note that there is a known issue with the normalization of linefeed characters inside of CDATA sections that you may encounter.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Grammar mistake in introduction
"An abstract class that the derives from to do serialization and deserialization." -- That the *what* derives from?