XmlDocument.CreateXmlDeclaration(String, String, String) XmlDocument.CreateXmlDeclaration(String, String, String) XmlDocument.CreateXmlDeclaration(String, String, String) XmlDocument.CreateXmlDeclaration(String, String, String) Method

Definición

Crea un nodo XmlDeclaration con los valores especificados.Creates an XmlDeclaration node with the specified values.

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

Parámetros

version
String String String String

La versión debe ser "1.0".The version must be "1.0".

encoding
String String String String

Valor del atributo de codificación.The value of the encoding attribute. Es la codificación que se usa cuando se guarda XmlDocument en un archivo o en un flujo; por tanto, se debe establecer en una cadena admitida por la clase Encoding ya que, en caso contrario, Save(String) produce un error.This is the encoding that is used when you save the XmlDocument to a file or a stream; therefore, it must be set to a string supported by the Encoding class, otherwise Save(String) fails. Si es null o String.Empty, el método Save no escribe un atributo de codificación en la declaración XML y, por tanto, se usa la codificación predeterminada, UTF-8.If this is null or String.Empty, the Save method does not write an encoding attribute on the XML declaration and therefore the default encoding, UTF-8, is used.

Nota: Si XmlDocument se guarda en TextWriter o en XmlTextWriter, se descartará este valor de codificación.Note: If the XmlDocument is saved to either a TextWriter or an XmlTextWriter, this encoding value is discarded. En su lugar, se usa la codificación de TextWriter o de XmlTextWriter.Instead, the encoding of the TextWriter or the XmlTextWriter is used. De este modo se garantiza que el fragmento XML que se escribe se puede volver a leer usando la codificación correcta.This ensures that the XML written out can be read back using the correct encoding.

standalone
String String String String

Este valor debe ser "yes" o "no".The value must be either "yes" or "no". Si es null o String.Empty, el método Save no escribe un atributo independiente en la declaración XML.If this is null or String.Empty, the Save method does not write a standalone attribute on the XML declaration.

Devoluciones

Nuevo nodo XmlDeclaration.The new XmlDeclaration node.

Excepciones

Los valores de version o standalone son algo diferentes de los especificados anteriormente.The values of version or standalone are something other than the ones specified above.

Ejemplos

En el ejemplo siguiente se crea una declaración XML y se agrega al documento.The following example creates an XML declaration and adds it to the document.

#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

Comentarios

Los atributos se exponen como propiedades especiales XmlDeclaration en el nodo y no XmlAttribute como nodos.The attributes are exposed as special properties on the XmlDeclaration node, and not as XmlAttribute nodes.

Aunque este método crea el nuevo objeto en el contexto del documento, no agrega automáticamente el nuevo objeto al árbol del documento.Although this method creates the new object in the context of the document, it does not automatically add the new object to the document tree. Para agregar el nuevo objeto, debe llamar explícitamente a uno de los métodos de inserción de nodo.To add the new object, you must explicitly call one of the node insert methods.

Según la recomendación del W3C lenguaje de marcado extensible (XML) 1,0, el XmlDeclaration nodo debe ser el primer nodo del documento.According to the W3C Extensible Markup Language (XML) 1.0 recommendation, the XmlDeclaration node must be the first node in the document.

Este método es una extensión de Microsoft para el Document Object Model (DOM).This method is a Microsoft extension to the Document Object Model (DOM).

Se aplica a

Consulte también: