XmlDocument.CreateXmlDeclaration(String, String, String) Metodo

Definizione

Spazio dei nomi:

System.Xml

Assembly:

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

Assembly:

System.Xml.ReaderWriter.dll

Assembly:

System.Xml.XmlDocument.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Crea un nodo XmlDeclaration con i valori specificati.

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

Parametri

version

String

La versione deve essere "1.0".

encoding

String

Valore dell'attributo di codifica. Si tratta della codifica usata quando si salva l'oggetto XmlDocument in un file o in un flusso; pertanto, deve essere impostata su una stringa supportata dalla classe Encoding, altrimenti Save(String) non riesce. Se il valore è null o String.Empty, il metodo Save non scrive un attributo di codifica nella dichiarazione XML e quindi viene usata la codifica predefinita UTF-8.

Nota: se l'oggetto XmlDocument viene salvato in TextWriter o in XmlTextWriter, questo valore di codifica viene rimosso. Al suo posto viene usata la codifica di TextWriter o XmlTextWriter. In questo modo l'XML scritto potrà essere nuovamente letto con la codifica corretta.

standalone

String

Il valore deve essere "yes" o "no". Se il valore è null o String.Empty, il metodo Save non scrive un attributo autonomo nella dichiarazione XML.

Restituisce

XmlDeclaration

Nuovo nodo XmlDeclaration.

Eccezioni

ArgumentException

I valori di version o standalone sono diversi da quelli specificati in precedenza.

Esempio

Nell'esempio seguente viene creata una dichiarazione XML e la aggiunge al documento.

#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

Commenti

Gli attributi vengono esposti come proprietà speciali nel XmlDeclaration nodo e non come XmlAttribute nodi.

Anche se questo metodo crea il nuovo oggetto nel contesto del documento, non aggiunge automaticamente il nuovo oggetto all'albero del documento. Per aggiungere il nuovo oggetto, è necessario chiamare in modo esplicito uno dei metodi di inserimento del nodo.

In base alla raccomandazione W3C Extensible Markup Language (XML) 1.0, il nodo deve essere il XmlDeclaration primo nodo del documento.

Questo metodo è un'estensione Microsoft per il modello a oggetti document (DOM).

Vedi anche

• XmlDeclaration