XmlWriter.WriteStartDocument Method

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

When overridden in a derived class, writes the XML declaration.

Overloads

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

Remarks

For the asynchronous version of this method, see WriteStartDocumentAsync.

WriteStartDocument(Boolean)

Source:

XmlWriter.cs

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

public:
 abstract void WriteStartDocument(bool standalone);

public abstract void WriteStartDocument (bool standalone);

abstract member WriteStartDocument : bool -> unit

Public MustOverride Sub WriteStartDocument (standalone As Boolean)

Parameters

standalone

Boolean

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

Exceptions

InvalidOperationException

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

-or-

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."

Remarks

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.

WriteStartDocument()

Source:

XmlWriter.cs

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

public:
 abstract void WriteStartDocument();

public abstract void WriteStartDocument ();

abstract member WriteStartDocument : unit -> unit

Public MustOverride Sub WriteStartDocument ()

Exceptions

InvalidOperationException

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

-or-

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."

Remarks

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. 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 WriteProcessingInstruction method is used to create another XML declaration, an exception will be thrown.

For the asynchronous version of this method, see WriteStartDocumentAsync.