XmlDocument.CreateXmlDeclaration(String, String, String) Méthode

Définition

Espace de noms:

System.Xml

Assemblys:

netstandard.dll, System.Xml.ReaderWriter.dll

Source:

XmlDocument.cs

Crée un XmlDeclaration nœud avec les valeurs spécifiées.

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

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

Paramètres

version

String

La version doit être « 1.0 ».

encoding

String

Valeur de l’attribut d’encodage. Il s’agit de l’encodage utilisé lorsque vous enregistrez le XmlDocument fichier dans un fichier ou un flux ; par conséquent, il doit être défini sur une chaîne prise en charge par la Encoding classe, sinon Save(String) échoue. Si elle est null ou String.Empty, la Save méthode n’écrit pas d’attribut d’encodage sur la déclaration XML et, par conséquent, l’encodage par défaut, UTF-8, est utilisé.

Remarque : Si l’objet XmlDocument est enregistré dans un TextWriter ou un XmlTextWriter, cette valeur d’encodage est ignorée. Au lieu de cela, l’encodage du TextWriter ou celui-ci XmlTextWriter est utilisé. Cela garantit que le code XML écrit peut être lu à l’aide de l’encodage correct.

standalone

String

La valeur doit être « oui » ou « non ». S’il s’agit null de String.Empty, la Save méthode n’écrit pas d’attribut autonome sur la déclaration XML.

Retours

XmlDeclaration

Nouveau XmlDeclaration nœud.

Exceptions

ArgumentException

Les valeurs ou versionstandalone sont autres que celles spécifiées ci-dessus.

Exemples

L’exemple suivant crée une déclaration XML et l’ajoute au 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

Remarques

Les attributs sont exposés sous forme de propriétés spéciales sur le XmlDeclaration nœud, et non en tant que XmlAttribute nœuds.

Bien que cette méthode crée le nouvel objet dans le contexte du document, il n’ajoute pas automatiquement le nouvel objet à l’arborescence de documents. Pour ajouter le nouvel objet, vous devez appeler explicitement l’une des méthodes d’insertion de nœud.

Selon la recommandation W3C Extensible Markup Language (XML) 1.0, le XmlDeclaration nœud doit être le premier nœud du document.

Cette méthode est une extension Microsoft au dom (Document Object Model).

Voir aussi

• XmlDeclaration