XmlDocument.CreateXmlDeclaration(String, String, String) Methode

Definitie

Hiermee maakt u een XmlDeclaration knooppunt met de opgegeven waarden.

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

Parameters

version
String

De versie moet 1.0 zijn.

encoding
String

De waarde van het coderingskenmerk. Dit is de codering die wordt gebruikt wanneer u het XmlDocument bestand of een stream opslaat. Daarom moet deze worden ingesteld op een tekenreeks die door de Encoding klasse wordt ondersteund, anders Save(String) mislukt. Als dit is null of String.Empty, schrijft de Save methode geen coderingskenmerk in de XML-declaratie en wordt daarom de standaardcodering, UTF-8, gebruikt.

Opmerking: Als de XmlDocument waarde is opgeslagen in een TextWriter of een XmlTextWriter, wordt deze coderingswaarde verwijderd. In plaats daarvan wordt de codering van de TextWriter of de gebruikte XmlTextWriter code gebruikt. Dit zorgt ervoor dat de XML die is geschreven, kan worden teruggelezen met behulp van de juiste codering.

standalone
String

De waarde moet 'ja' of 'nee' zijn. Als dit is null of String.Empty, schrijft de Save methode geen zelfstandig kenmerk in de XML-declaratie.

Retouren

Het nieuwe XmlDeclaration knooppunt.

Uitzonderingen

De waarden van version of standalone zijn iets anders dan de waarden die hierboven zijn opgegeven.

Voorbeelden

In het volgende voorbeeld wordt een XML-declaratie gemaakt en toegevoegd aan het document.

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

Opmerkingen

De kenmerken worden weergegeven als speciale eigenschappen op het XmlDeclaration knooppunt en niet als XmlAttribute knooppunten.

Hoewel met deze methode het nieuwe object wordt gemaakt in de context van het document, wordt het nieuwe object niet automatisch toegevoegd aan de documentstructuur. Als u het nieuwe object wilt toevoegen, moet u expliciet een van de methoden voor het invoegen van knooppunten aanroepen.

Volgens de aanbeveling W3C Extensible Markup Language (XML) 1.0 moet het XmlDeclaration knooppunt het eerste knooppunt in het document zijn.

Deze methode is een Microsoft extensie voor het Document Object Model (DOM).

Van toepassing op

Zie ook