XmlDocument.CreateXmlDeclaration(String, String, String) Methode

Definition

Namespace:

System.Xml

Assemblys:

System.Xml.dll, System.Xml.XmlDocument.dll

Assembly:

System.Xml.ReaderWriter.dll

Assembly:

System.Xml.XmlDocument.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Erstellt einen XmlDeclaration-Knoten mit den angegebenen Werten.

public:
 virtual System::Xml::XmlDeclaration ^ CreateXmlDeclaration(System::String ^ version, System::String ^ encoding, System::String ^ standalone);

public virtual System.Xml.XmlDeclaration CreateXmlDeclaration (string version, string encoding, string standalone);

public virtual System.Xml.XmlDeclaration CreateXmlDeclaration (string version, string? encoding, string? standalone);

abstract member CreateXmlDeclaration : string * string * string -> System.Xml.XmlDeclaration
override this.CreateXmlDeclaration : string * string * string -> System.Xml.XmlDeclaration

Public Overridable Function CreateXmlDeclaration (version As String, encoding As String, standalone As String) As XmlDeclaration

Parameter

version

String

Die Version muss "1.0" sein.

encoding

String

Der Wert des Codierungsattributs. Dies ist die Codierung, die für das Speichern des XmlDocument in einer Datei oder einem Stream verwendet wird. Daher muss das Codierungsattribut auf eine von der Encoding-Klasse unterstützte Zeichenfolge festgelegt werden. Andernfalls schlägt Save(String) fehl. Wenn der Wert null oder „String.Empty“ ist, schreibt die Save -Methode kein Codierungsattribut für die XML-Deklaration, und es wird daher die Standardcodierung UTF-8 verwendet.

Wenn das XmlDocument in einem TextWriter oder einem XmlTextWritergespeichert wird, wird dieser Codierungswert verworfen. Stattdessen wird die Codierung des TextWriter oder XmlTextWriter verwendet. Dadurch ist gewährleistet, dass die geschriebenen XML-Daten mit der richtigen Codierung eingelesen werden können.

standalone

String

Der Wert muss entweder yes oder no sein. Wenn der Wert null oder String.Empty ist, schreibt die Save-Methode kein eigenständiges Attribut für die XML-Deklaration.

Gibt zurück

XmlDeclaration

Der neue XmlDeclaration-Knoten.

Ausnahmen

ArgumentException

Die Werte von version oder standalone unterscheiden sich von den oben angegebenen Werten.

Beispiele

Im folgenden Beispiel wird eine XML-Deklaration erstellt und dem Dokument hinzugefügt.

#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlDocument^ doc = gcnew XmlDocument;
   doc->LoadXml( "<book genre='novel' ISBN='1-861001-57-5'><title>Pride And Prejudice</title></book>" );
   
   //Create an XML declaration. 
   XmlDeclaration^ xmldecl;
   xmldecl = doc->CreateXmlDeclaration( "1.0", nullptr, nullptr );
   
   //Add the new node to the document.
   XmlElement^ root = doc->DocumentElement;
   doc->InsertBefore( xmldecl, root );
   Console::WriteLine( "Display the modified XML..." );
   doc->Save( Console::Out );
}

using System;
using System.IO;
using System.Xml;

public class Sample
{
  public static void Main()
  {
    XmlDocument doc = new XmlDocument();
    doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" +
                "<title>Pride And Prejudice</title>" +
                "</book>");

    //Create an XML declaration.
    XmlDeclaration xmldecl;
    xmldecl = doc.CreateXmlDeclaration("1.0",null,null);

    //Add the new node to the document.
    XmlElement root = doc.DocumentElement;
    doc.InsertBefore(xmldecl, root);

    Console.WriteLine("Display the modified XML...");
    doc.Save(Console.Out);
  }
}

Option Explicit
Option Strict

Imports System.IO
Imports System.Xml

Public Class Sample
    
    Public Shared Sub Main()
        Dim doc As New XmlDocument()
        doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" & _
                    "<title>Pride And Prejudice</title>" & _
                    "</book>")
        
        'Create an XML declaration. 
        Dim xmldecl As XmlDeclaration
        xmldecl = doc.CreateXmlDeclaration("1.0", Nothing, Nothing)
        
        'Add the new node to the document.
        Dim root As XmlElement = doc.DocumentElement
        doc.InsertBefore(xmldecl, root)
        
        Console.WriteLine("Display the modified XML...")
        doc.Save(Console.Out)
    End Sub
End Class

Hinweise

Die Attribute werden als spezielle Eigenschaften für den XmlDeclaration Knoten und nicht als XmlAttribute Knoten verfügbar gemacht.

Obwohl diese Methode das neue Objekt im Kontext des Dokuments erstellt, wird das neue Objekt nicht automatisch der Dokumentstruktur hinzugefügt. Um das neue Objekt hinzuzufügen, müssen Sie explizit eine der Methoden zum Einfügen von Knoten aufrufen.

Gemäß der Empfehlung der W3C Extensible Markup Language (XML) 1.0 muss der XmlDeclaration Knoten der erste Knoten im Dokument sein.

Diese Methode ist eine Microsoft-Erweiterung für das Dokumentobjektmodell (DOM).

Siehe auch

• XmlDeclaration