XmlDictionaryWriter Class

Definition

Represents an abstract class that Windows Communication Foundation (WCF) derives from XmlWriter to do serialization and deserialization.

public ref class XmlDictionaryWriter abstract : System::Xml::XmlWriter
public abstract class XmlDictionaryWriter : System.Xml.XmlWriter
type XmlDictionaryWriter = class
    inherit XmlWriter
Public MustInherit Class XmlDictionaryWriter
Inherits XmlWriter
Inheritance
XmlDictionaryWriter
Derived

Remarks

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.

Constructors

XmlDictionaryWriter()

Initializes a new instance of the XmlDictionaryWriter class.

Properties

CanCanonicalize

This property always returns false. Its derived classes can override to return true if they support canonicalization.

Settings

Gets the XmlWriterSettings object used to create this XmlWriter instance.

(Inherited from XmlWriter)
WriteState

When overridden in a derived class, gets the state of the writer.

(Inherited from XmlWriter)
XmlLang

When overridden in a derived class, gets the current xml:lang scope.

(Inherited from XmlWriter)
XmlSpace

When overridden in a derived class, gets an XmlSpace representing the current xml:space scope.

(Inherited from XmlWriter)

Methods

Close()

When overridden in a derived class, closes this stream and the underlying stream.

(Inherited from XmlWriter)
CreateBinaryWriter(Stream)

Creates an instance of XmlDictionaryWriter that writes WCF binary XML format.

CreateBinaryWriter(Stream, IXmlDictionary)

Creates an instance of XmlDictionaryWriter that writes WCF binary XML format.

CreateBinaryWriter(Stream, IXmlDictionary, XmlBinaryWriterSession)

Creates an instance of XmlDictionaryWriter that writes WCF binary XML format.

CreateBinaryWriter(Stream, IXmlDictionary, XmlBinaryWriterSession, Boolean)

Creates an instance of XmlDictionaryWriter that writes WCF binary XML format.

CreateDictionaryWriter(XmlWriter)

Creates an instance of XmlDictionaryWriter from an existing XmlWriter.

CreateMtomWriter(Stream, Encoding, Int32, String)

Creates an instance of XmlDictionaryWriter that writes XML in the MTOM format.

CreateMtomWriter(Stream, Encoding, Int32, String, String, String, Boolean, Boolean)

Creates an instance of XmlDictionaryWriter that writes XML in the MTOM format.

CreateTextWriter(Stream)

Creates an instance of XmlDictionaryWriter that writes text XML.

CreateTextWriter(Stream, Encoding)

Creates an instance of XmlDictionaryWriter that writes text XML.

CreateTextWriter(Stream, Encoding, Boolean)

Creates an instance of XmlDictionaryWriter that writes text XML.

Dispose()

Releases all resources used by the current instance of the XmlWriter class.

(Inherited from XmlWriter)
Dispose(Boolean)

Releases the unmanaged resources used by the XmlWriter and optionally releases the managed resources.

(Inherited from XmlWriter)
DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

(Inherited from XmlWriter)
DisposeAsyncCore()

Performs application-defined tasks associated with freeing, releasing, or resetting managed resources asynchronously.

(Inherited from XmlWriter)
EndCanonicalization()

When implemented by a derived class, it stops the canonicalization started by the matching StartCanonicalization(Stream, Boolean, String[]) call.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
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)
FlushAsync()

Asynchronously flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.

(Inherited from XmlWriter)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
LookupPrefix(String)

When overridden in a derived class, returns the closest prefix defined in the current namespace scope for the namespace URI.

(Inherited from XmlWriter)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
StartCanonicalization(Stream, Boolean, String[])

When implemented by a derived class, it starts the canonicalization.

ToString()

Returns a string that represents the current object.

(Inherited from Object)
WriteArray(String, String, String, Boolean[], Int32, Int32)

Writes nodes from a Boolean array.

WriteArray(String, String, String, DateTime[], Int32, Int32)

Writes nodes from a DateTime array.

WriteArray(String, String, String, Decimal[], Int32, Int32)

Writes nodes from a Decimal array.

WriteArray(String, String, String, Double[], Int32, Int32)

Writes nodes from a Double array.

WriteArray(String, String, String, Guid[], Int32, Int32)

Writes nodes from a Guid array.

WriteArray(String, String, String, Int16[], Int32, Int32)

Writes nodes from a Int16 array.

WriteArray(String, String, String, Int32[], Int32, Int32)

Writes nodes from a Int32 array.

WriteArray(String, String, String, Int64[], Int32, Int32)

Writes nodes from a Int64 array.

WriteArray(String, String, String, Single[], Int32, Int32)

Writes nodes from a Single array.

WriteArray(String, String, String, TimeSpan[], Int32, Int32)

Writes nodes from a TimeSpan array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, Boolean[], Int32, Int32)

Writes nodes from a Boolean array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, DateTime[], Int32, Int32)

Writes nodes from a DateTime array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, Decimal[], Int32, Int32)

Writes nodes from a Decimal array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, Double[], Int32, Int32)

Writes nodes from a Double array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, Guid[], Int32, Int32)

Writes nodes from a Guid array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, Int16[], Int32, Int32)

Writes nodes from a Int16 array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, Int32[], Int32, Int32)

Writes nodes from a Int32 array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, Int64[], Int32, Int32)

Writes nodes from a Int64 array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, Single[], Int32, Int32)

Writes nodes from a Single array.

WriteArray(String, XmlDictionaryString, XmlDictionaryString, TimeSpan[], Int32, Int32)

Writes nodes from a TimeSpan array.

WriteAttributes(XmlReader, Boolean)

When overridden in a derived class, writes out all the attributes found at the current position in the XmlReader.

(Inherited from XmlWriter)
WriteAttributesAsync(XmlReader, Boolean)

Asynchronously writes out all the attributes found at the current position in the XmlReader.

(Inherited from XmlWriter)
WriteAttributeString(String, String)

When overridden in a derived class, writes out the attribute with the specified local name and value.

(Inherited from XmlWriter)
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)
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)
WriteAttributeString(String, XmlDictionaryString, XmlDictionaryString, String)

Writes an attribute qualified name and value.

WriteAttributeString(XmlDictionaryString, XmlDictionaryString, String)

Writes an attribute qualified name and value.

WriteAttributeStringAsync(String, String, String, String)

Asynchronously writes out the attribute with the specified prefix, local name, namespace URI, and value.

(Inherited from XmlWriter)
WriteBase64(Byte[], Int32, Int32)

When overridden in a derived class, encodes the specified binary bytes as Base64 and writes out the resulting text.

(Inherited from XmlWriter)
WriteBase64Async(Byte[], Int32, Int32)

Asynchronously encodes the specified binary bytes as Base64 and writes out the resulting text.

WriteBase64Async(Byte[], Int32, Int32)

Asynchronously encodes the specified binary bytes as Base64 and writes out the resulting text.

(Inherited from XmlWriter)
WriteBinHex(Byte[], Int32, Int32)

When overridden in a derived class, encodes the specified binary bytes as BinHex and writes out the resulting text.

(Inherited from XmlWriter)
WriteBinHexAsync(Byte[], Int32, Int32)

Asynchronously encodes the specified binary bytes as BinHex and writes out the resulting text.

(Inherited from XmlWriter)
WriteCData(String)

When overridden in a derived class, writes out a <![CDATA[...]]> block containing the specified text.

(Inherited from XmlWriter)
WriteCDataAsync(String)

Asynchronously writes out a <![CDATA[...]]> block containing the specified text.

(Inherited from XmlWriter)
WriteCharEntity(Char)

When overridden in a derived class, forces the generation of a character entity for the specified Unicode character value.

(Inherited from XmlWriter)
WriteCharEntityAsync(Char)

Asynchronously forces the generation of a character entity for the specified Unicode character value.

(Inherited from XmlWriter)
WriteChars(Char[], Int32, Int32)

When overridden in a derived class, writes text one buffer at a time.

(Inherited from XmlWriter)
WriteCharsAsync(Char[], Int32, Int32)

Asynchronously writes text one buffer at a time.

(Inherited from XmlWriter)
WriteComment(String)

When overridden in a derived class, writes out a comment <!--...--> containing the specified text.

(Inherited from XmlWriter)
WriteCommentAsync(String)

Asynchronously writes out a comment <!--...--> containing the specified text.

(Inherited from XmlWriter)
WriteDocType(String, String, String, String)

When overridden in a derived class, writes the DOCTYPE declaration with the specified name and optional attributes.

(Inherited from XmlWriter)
WriteDocTypeAsync(String, String, String, String)

Asynchronously writes the DOCTYPE declaration with the specified name and optional attributes.

(Inherited from XmlWriter)
WriteElementString(String, String)

Writes an element with the specified local name and value.

(Inherited from XmlWriter)
WriteElementString(String, String, String)

Writes an element with the specified local name, namespace URI, and value.

(Inherited from XmlWriter)
WriteElementString(String, String, String, String)

Writes an element with the specified prefix, local name, namespace URI, and value.

(Inherited from XmlWriter)
WriteElementString(String, XmlDictionaryString, XmlDictionaryString, String)

Writes an element with a text content.

WriteElementString(XmlDictionaryString, XmlDictionaryString, String)

Writes an element with a text content.

WriteElementStringAsync(String, String, String, String)

Asynchronously writes an element with the specified prefix, local name, namespace URI, and value.

(Inherited from XmlWriter)
WriteEndAttribute()

When overridden in a derived class, closes the previous WriteStartAttribute(String, String) call.

(Inherited from XmlWriter)
WriteEndAttributeAsync()

Asynchronously closes the previous WriteStartAttribute(String, String) call.

(Inherited from XmlWriter)
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)
WriteEndDocumentAsync()

Asynchronously closes any open elements or attributes and puts the writer back in the Start state.

(Inherited from XmlWriter)
WriteEndElement()

When overridden in a derived class, closes one element and pops the corresponding namespace scope.

(Inherited from XmlWriter)
WriteEndElementAsync()

Asynchronously closes one element and pops the corresponding namespace scope.

(Inherited from XmlWriter)
WriteEntityRef(String)

When overridden in a derived class, writes out an entity reference as &name;.

(Inherited from XmlWriter)
WriteEntityRefAsync(String)

Asynchronously writes out an entity reference as &name;.

(Inherited from XmlWriter)
WriteFullEndElement()

When overridden in a derived class, closes one element and pops the corresponding namespace scope.

(Inherited from XmlWriter)
WriteFullEndElementAsync()

Asynchronously closes one element and pops the corresponding namespace scope.

(Inherited from XmlWriter)
WriteName(String)

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 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).

(Inherited from XmlWriter)
WriteNameAsync(String)

Asynchronously writes out the specified name, ensuring it is a valid name according to the W3C XML 1.0 recommendation (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).

(Inherited from XmlWriter)
WriteNmToken(String)

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 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).

(Inherited from XmlWriter)
WriteNmTokenAsync(String)

Asynchronously writes out the specified name, ensuring it is a valid NmToken according to the W3C XML 1.0 recommendation (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).

(Inherited from XmlWriter)
WriteNode(XmlDictionaryReader, Boolean)

Writes the current XML node from an XmlDictionaryReader.

WriteNode(XmlReader, Boolean)

Writes the current XML node from an XmlReader.

WriteNode(XPathNavigator, Boolean)

Copies everything from the XPathNavigator object to the writer. The position of the XPathNavigator remains unchanged.

(Inherited from XmlWriter)
WriteNodeAsync(XmlReader, Boolean)

Asynchronously copies everything from the reader to the writer and moves the reader to the start of the next sibling.

(Inherited from XmlWriter)
WriteNodeAsync(XPathNavigator, Boolean)

Asynchronously copies everything from the XPathNavigator object to the writer. The position of the XPathNavigator remains unchanged.

(Inherited from XmlWriter)
WriteProcessingInstruction(String, String)

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)
WriteProcessingInstructionAsync(String, String)

Asynchronously writes out a processing instruction with a space between the name and text as follows: <?name text?>.

(Inherited from XmlWriter)
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)
WriteQualifiedName(XmlDictionaryString, XmlDictionaryString)

Writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace.

WriteQualifiedNameAsync(String, String)

Asynchronously writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace.

(Inherited from XmlWriter)
WriteRaw(Char[], Int32, Int32)

When overridden in a derived class, writes raw markup manually from a character buffer.

(Inherited from XmlWriter)
WriteRaw(String)

When overridden in a derived class, writes raw markup manually from a string.

(Inherited from XmlWriter)
WriteRawAsync(Char[], Int32, Int32)

Asynchronously writes raw markup manually from a character buffer.

(Inherited from XmlWriter)
WriteRawAsync(String)

Asynchronously writes raw markup manually from a string.

(Inherited from XmlWriter)
WriteStartAttribute(String)

Writes the start of an attribute with the specified local name.

(Inherited from XmlWriter)
WriteStartAttribute(String, String)

Writes the start of an attribute with the specified local name and namespace URI.

(Inherited from XmlWriter)
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)
WriteStartAttribute(String, XmlDictionaryString, XmlDictionaryString)

Writes the start of an attribute with the specified prefix, local name, and namespace URI.

WriteStartAttribute(XmlDictionaryString, XmlDictionaryString)

Writes the start of an attribute with the specified local name, and namespace URI.

WriteStartAttributeAsync(String, String, String)

Asynchronously writes the start of an attribute with the specified prefix, local name, and namespace URI.

(Inherited from XmlWriter)
WriteStartDocument()

When overridden in a derived class, writes the XML declaration with the version "1.0".

(Inherited from XmlWriter)
WriteStartDocument(Boolean)

When overridden in a derived class, writes the XML declaration with the version "1.0" and the standalone attribute.

(Inherited from XmlWriter)
WriteStartDocumentAsync()

Asynchronously writes the XML declaration with the version "1.0".

(Inherited from XmlWriter)
WriteStartDocumentAsync(Boolean)

Asynchronously writes the XML declaration with the version "1.0" and the standalone attribute.

(Inherited from XmlWriter)
WriteStartElement(String)

When overridden in a derived class, writes out a start tag with the specified local name.

(Inherited from XmlWriter)
WriteStartElement(String, String)

When overridden in a derived class, writes the specified start tag and associates it with the given namespace.

(Inherited from XmlWriter)
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)
WriteStartElement(String, XmlDictionaryString, XmlDictionaryString)

Writes the specified start tag and associates it with the given namespace and prefix.

WriteStartElement(XmlDictionaryString, XmlDictionaryString)

Writes the specified start tag and associates it with the given namespace.

WriteStartElementAsync(String, String, String)

Asynchronously writes the specified start tag and associates it with the given namespace and prefix.

(Inherited from XmlWriter)
WriteString(String)

When overridden in a derived class, writes the given text content.

(Inherited from XmlWriter)
WriteString(XmlDictionaryString)

Writes the given text content.

WriteStringAsync(String)

Asynchronously writes the given text content.

(Inherited from XmlWriter)
WriteSurrogateCharEntity(Char, Char)

When overridden in a derived class, generates and writes the surrogate character entity for the surrogate character pair.

(Inherited from XmlWriter)
WriteSurrogateCharEntityAsync(Char, Char)

Asynchronously generates and writes the surrogate character entity for the surrogate character pair.

(Inherited from XmlWriter)
WriteTextNode(XmlDictionaryReader, Boolean)

Writes the text node that an XmlDictionaryReader is currently positioned on.

WriteValue(Boolean)

Writes a Boolean value.

(Inherited from XmlWriter)
WriteValue(DateTime)

Writes a DateTime value.

(Inherited from XmlWriter)
WriteValue(DateTimeOffset)

Writes a DateTimeOffset value.

(Inherited from XmlWriter)
WriteValue(Decimal)

Writes a Decimal value.

(Inherited from XmlWriter)
WriteValue(Double)

Writes a Double value.

(Inherited from XmlWriter)
WriteValue(Guid)

Writes a Guid value.

WriteValue(Int32)

Writes a Int32 value.

(Inherited from XmlWriter)
WriteValue(Int64)

Writes a Int64 value.

(Inherited from XmlWriter)
WriteValue(IStreamProvider)

Writes a value from an IStreamProvider.

WriteValue(Object)

Writes the object value.

(Inherited from XmlWriter)
WriteValue(Single)

Writes a single-precision floating-point number.

(Inherited from XmlWriter)
WriteValue(String)

Writes a String value.

(Inherited from XmlWriter)
WriteValue(TimeSpan)

Writes a TimeSpan value.

WriteValue(UniqueId)

Writes a Unique Id value.

WriteValue(XmlDictionaryString)

Writes a XmlDictionaryString value.

WriteValueAsync(IStreamProvider)

Asynchronously writes a value from an IStreamProvider.

WriteWhitespace(String)

When overridden in a derived class, writes out the given white space.

(Inherited from XmlWriter)
WriteWhitespaceAsync(String)

Asynchronously writes out the given white space.

(Inherited from XmlWriter)
WriteXmlAttribute(String, String)

Writes a standard XML attribute in the current node.

WriteXmlAttribute(XmlDictionaryString, XmlDictionaryString)

Writes an XML attribute in the current node.

WriteXmlnsAttribute(String, String)

Writes a namespace declaration attribute.

WriteXmlnsAttribute(String, XmlDictionaryString)

Writes a namespace declaration attribute.

Explicit Interface Implementations

IDisposable.Dispose()

For a description of this member, see Dispose().

(Inherited from XmlWriter)

Extension Methods

ConfigureAwait(IAsyncDisposable, Boolean)

Configures how awaits on the tasks returned from an async disposable are performed.

Applies to