XmlDocument.CreateXmlDeclaration(String, String, String) Metoda

Definice

Obor názvů:

System.Xml

Sestavení:

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

Sestavení:

System.Xml.ReaderWriter.dll

Sestavení:

System.Xml.XmlDocument.dll

Sestavení:

System.Xml.dll

Sestavení:

netstandard.dll

XmlDeclaration Vytvoří uzel se zadanými hodnotami.

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

Parametry

version

String

Verze musí být 1.0.

encoding

String

Hodnota atributu kódování. Toto je kódování, které se používá při uložení XmlDocument souboru nebo datového proudu. Proto musí být nastaven na řetězec podporovaný Encoding třídou, jinak Save(String) selže. Pokud je null to nebo String.Empty, Save metoda nezapisuje atribut kódování do deklarace XML, a proto se použije výchozí kódování UTF-8.

Poznámka: Pokud XmlDocument je uložena do nebo do TextWriter XmlTextWriter, tato hodnota kódování se zahodí. Místo toho se použije kódování TextWriter nebo je XmlTextWriter použito. Tím zajistíte, že se kód XML zapisuje zpět pomocí správného kódování.

standalone

String

Hodnota musí být buď "ano", nebo "ne". Pokud je null to nebo String.Empty, Save metoda nezapisuje samostatný atribut na deklaraci XML.

Návraty

XmlDeclaration

Nový XmlDeclaration uzel.

Výjimky

ArgumentException

Hodnoty version nebo standalone jsou jiné než hodnoty uvedené výše.

Příklady

Následující příklad vytvoří deklaraci XML a přidá ji do dokumentu.

#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

Poznámky

Atributy jsou vystaveny jako speciální vlastnosti na XmlDeclaration uzlu, a ne jako XmlAttribute uzly.

I když tato metoda vytvoří nový objekt v kontextu dokumentu, nepřidá automaticky nový objekt do stromu dokumentu. Chcete-li přidat nový objekt, musíte explicitně volat jednu z metod vložení uzlu.

Podle doporučení XmlDeclaration W3C Extensible Markup Language (XML) 1.0 musí být uzel prvním uzlem v dokumentu.

Tato metoda je rozšířením Microsoftu na model DOM (Document Object Model).

Viz také

• XmlDeclaration