XmlDocument.CreateXmlDeclaration(String, String, String) Methode

Definition

Erstellt einen XmlDeclaration-Knoten mit den angegebenen Werten.Creates an XmlDeclaration node with the specified values.

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);
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.The version must be "1.0".

encoding
String

Der Wert des Codierungsattributs.The value of the encoding attribute. 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.This is the encoding that is used when you save the XmlDocument to a file or a stream; therefore, it must be set to a string supported by the Encoding class, otherwise Save(String) fails. 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.If this is null or String.Empty, the Save method does not write an encoding attribute on the XML declaration and therefore the default encoding, UTF-8, is used.

Hinweis: Wenn das XmlDocument in einem TextWriter oder einem XmlTextWriter gespeichert wird, wird dieser Codierungswert verworfen.Note: If the XmlDocument is saved to either a TextWriter or an XmlTextWriter, this encoding value is discarded. Stattdessen wird die Codierung des TextWriter oder XmlTextWriter verwendet.Instead, the encoding of the TextWriter or the XmlTextWriter is used. Dadurch ist gewährleistet, dass die geschriebenen XML-Daten mit der richtigen Codierung eingelesen werden können.This ensures that the XML written out can be read back using the correct encoding.

standalone
String

Der Wert muss entweder yes oder no sein.The value must be either "yes" or "no". Wenn der Wert null oder String.Empty ist, schreibt die Save-Methode kein eigenständiges Attribut für die XML-Deklaration.If this is null or String.Empty, the Save method does not write a standalone attribute on the XML declaration.

Gibt zurück

Der neue XmlDeclaration-Knoten.The new XmlDeclaration node.

Ausnahmen

Die Werte von version oder standalone unterscheiden sich von den oben angegebenen Werten.The values of version or standalone are something other than the ones specified above.

Beispiele

Im folgenden Beispiel wird eine XML-Deklaration erstellt und dem Dokument hinzugefügt.The following example creates an XML declaration and adds it to the document.

#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 des XmlDeclaration Knotens und nicht als XmlAttribute Knoten verfügbar gemacht.The attributes are exposed as special properties on the XmlDeclaration node, and not as XmlAttribute nodes.

Obwohl diese Methode das neue-Objekt im Kontext des Dokuments erstellt, wird das neue-Objekt nicht automatisch der Dokumentstruktur hinzugefügt.Although this method creates the new object in the context of the document, it does not automatically add the new object to the document tree. Um das neue-Objekt hinzuzufügen, müssen Sie explizit eine der Knoten Einfügemethoden aufzurufen.To add the new object, you must explicitly call one of the node insert methods.

Gemäß der Empfehlung W3C Extensible Markup Language (XML) 1,0muss der XmlDeclaration Knoten der erste Knoten im Dokument sein.According to the W3C Extensible Markup Language (XML) 1.0 recommendation, the XmlDeclaration node must be the first node in the document.

Diese Methode ist eine Microsoft-Erweiterung für die Dokumentobjektmodell (DOM).This method is a Microsoft extension to the Document Object Model (DOM).

Gilt für:

Siehe auch