XmlTextWriter.WriteStartDocument Method (Boolean)

 

Writes the XML declaration with the version "1.0" and the standalone attribute.

Namespace:   System.Xml
Assembly:  System.Xml (in System.Xml.dll)

public override void WriteStartDocument(
	bool standalone
)

Parameters

standalone
Type: System.Boolean

If true, it writes "standalone=yes"; if false, it writes "standalone=no".

Exception Condition
InvalidOperationException

This is not the first write method called after the constructor.

System_CAPS_noteNote

Starting with the .NET Framework 2.0, we recommend that you create XmlWriter instances by using the XmlWriter.Create method and the XmlWriterSettings class to take advantage of new functionality.

The encoding level of the document is determined by how the writer is implemented. For example, if an Encoding object is specified in the XmlTextWriter constructor, this determines the value of the encoding 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 WriteProcessingInstruction method is used to create another XML declaration, an exception is thrown.

.NET Framework
Available since 1.1
Return to top
Show: