System.Xml.XmlWriter.WriteStartDocument Method

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

Syntax

public abstract void WriteStartDocument ()

Exceptions

TypeReason
InvalidOperationExceptionThe XmlWriter.WriteState is not WriteState.Start.

Remarks

The encoding level of the document is determined by how the writer is implemented. For example, if an System.Text.Encoding object is specified in the XmlTextWriter constructor, this determines the value of the encoding attribute. This method does not create a standalone attribute.

When WriteStartDocument is called the writer validates that what you are writing is a well-formed XML document. For example, it checks that the XML declaration is the first node, that one and only one root-level element exists, and so on. If this method is not called, the writer assumes an XML fragment is being written and applies no root level rules.

If WriteStartDocument has been called and then the XmlWriter.WriteProcessingInstruction(string, string) method is used to create another XML declaration, an exception will be thrown.

For the asynchronous version of this method, see XmlWriter.WriteStartDocumentAsync.

Requirements

Namespace: System.Xml
Assembly: System.Xml (in System.Xml.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0