XmlDocument.CreateXmlDeclaration(String, String, String) Metod

Definition

Namnområde:
System.Xml
Sammansättningar:
System.Xml.dll, System.Xml.XmlDocument.dll
Sammansättningar:
netstandard.dll, System.Xml.ReaderWriter.dll
Sammansättning:
System.Xml.XmlDocument.dll
Sammansättning:
System.Xml.ReaderWriter.dll
Sammansättning:
System.Xml.dll
Sammansättning:
netstandard.dll
Källa:
XmlDocument.cs
Källa:
XmlDocument.cs
Källa:
XmlDocument.cs
Källa:
XmlDocument.cs
Källa:
XmlDocument.cs

Skapar en XmlDeclaration nod med de angivna värdena.

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

Parametrar

version
String

Versionen måste vara "1.0".

encoding
String

Värdet för kodningsattributet. Det här är den kodning som används när du sparar till XmlDocument en fil eller en dataström. Därför måste den vara inställd på en sträng som stöds av Encoding klassen, annars Save(String) misslyckas. Om detta är null eller String.Empty Save skriver metoden inte ett kodningsattribut i XML-deklarationen och därför används standardkodningen UTF-8.

Obs! Om XmlDocument sparas till antingen en TextWriter eller ett XmlTextWriterignoreras det här kodningsvärdet. I stället används kodningen av TextWriter eller XmlTextWriter . Detta säkerställer att xml-koden som skrivs ut kan läsas tillbaka med rätt kodning.

standalone
String

Värdet måste vara antingen "ja" eller "nej". Om det här är null eller String.Empty Save skriver metoden inte ett fristående attribut i XML-deklarationen.

Returer

XmlDeclaration

Den nya XmlDeclaration noden.

Undantag

ArgumentException

Värdena för version eller standalone är något annat än de som anges ovan.

Exempel

I följande exempel skapas en XML-deklaration och den läggs till i dokumentet.

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

Kommentarer

Attributen exponeras som särskilda egenskaper på XmlDeclaration noden och inte som XmlAttribute noder.

Även om den här metoden skapar det nya objektet i dokumentets kontext, lägger det inte automatiskt till det nya objektet i dokumentträdet. Om du vill lägga till det nya objektet måste du uttryckligen anropa någon av nodinfogningsmetoderna.

Enligt rekommendationen W3C XmlDeclaration måste noden vara den första noden i dokumentet.

Den här metoden är ett Microsoft-tillägg till dokumentobjektmodellen (DOM).

Gäller för

Se även