WriteStartDocument Method (Boolean)
Collapse the table of content
Expand the table of content

XmlWriter.WriteStartDocument Method (Boolean)

 

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

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

Public MustOverride Sub WriteStartDocument (
	standalone As Boolean
)

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.

InvalidOperationException

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message “An asynchronous operation is already in progress.”

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 will be thrown.

For the asynchronous version of this method, see WriteStartDocumentAsync.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft