XmlDocument.CreateXmlDeclaration-Methode

Artikel
08/20/2007

Erstellt einen XmlDeclaration-Knoten mit den angegebenen Werten.

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

Syntax

'Declaration
Public Overridable Function CreateXmlDeclaration ( _
    version As String, _
    encoding As String, _
    standalone As String _
) As XmlDeclaration
'Usage
Dim instance As XmlDocument
Dim version As String
Dim encoding As String
Dim standalone As String
Dim returnValue As XmlDeclaration

returnValue = instance.CreateXmlDeclaration(version, encoding, standalone)

public virtual XmlDeclaration CreateXmlDeclaration (
    string version,
    string encoding,
    string standalone
)

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

public XmlDeclaration CreateXmlDeclaration (
    String version, 
    String encoding, 
    String standalone
)

public function CreateXmlDeclaration (
    version : String, 
    encoding : String, 
    standalone : String
) : XmlDeclaration

Parameter

version
version muss "1.0"sein.

encoding
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 fehl. Wenn der Wert NULL (Nothing in Visual Basic) oder String.Empty ist, schreibt die Save-Methode kein Codierungsattribut für die XML-Deklaration, und es wird daher die Standardcodierung UTF-8 verwendet.

Hinweis: Wenn das XmlDocument in einem TextWriter oder einem XmlTextWriter gespeichert 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 zurückgelesen werden können.

standalone
Der Wert muss entweder yes oder no sein. Wenn der Wert NULL (Nothing in Visual Basic) oder String.Empty ist, schreibt die Save-Methode kein eigenständiges Attribut für die XML-Deklaration.

Rückgabewert

Der neue XmlDeclaration-Knoten.

Ausnahmen

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

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 es nicht automatisch der Dokumentstruktur hinzugefügt. Rufen Sie eine der Methoden zum Einfügen von Knoten explizit auf, um das neue Objekt hinzuzufügen.

Entsprechend der W3C-Empfehlung Extensible Markup Language (XML) 1.0 (www.w3.org/TR/1998/REC-xml-19980210, nur auf Englisch verfügbar) muss der XmlDeclaration-Knoten der erste Knoten im Dokument sein.

Diese Methode ist eine Microsoft-Erweiterung des Dokumentobjektmodells (Document Object Model, DOM).

Beispiel

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

Option Explicit
Option Strict

Imports System
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 'Main
End Class 'Sample

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);
  }
}

#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 );
}

import System.*;
import System.IO.*;
import System.Xml.*;

public class Sample
{
    public static void main(String[] args)
    {
        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.get_DocumentElement();
        doc.InsertBefore(xmlDecl, root);

        Console.WriteLine("Display the modified XML...");
        doc.Save(Console.get_Out());
    } //main
} //Sample

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0, 1.0

Siehe auch

Referenz

XmlDocument-Klasse
XmlDocument-Member
System.Xml-Namespace
XmlDeclaration-Klasse

Freigeben über