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

Definição

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Origem:

XmlDocument.cs

Cria um nó XmlDeclaration com os valores especificados.

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

A versão deve ser “1.0”.

encoding

String

O valor do atributo de codificação. Essa é a codificação usada quando você salva o XmlDocument em um arquivo ou um fluxo, portanto, ele deve ser definido como uma cadeia de caracteres com suporte na classe Encoding, caso contrário Save(String) falhará. Se isso for null ou String.Empty, o método Save não grava um atributo de codificação na declaração XML e, portanto, o padrão de codificação UTF-8 é usado.

Observação: se o XmlDocument for salvo como um TextWriter ou um XmlTextWriter, esse valor de codificação é descartado. Em vez disso, a codificação do TextWriter ou XmlTextWriter é usada. Isso garante que o XML gravado possa ser lido usando a codificação correta.

standalone

String

O valor deve ser “sim” ou “não”. Se isso for null ou String.Empty, o método Save não gravará um atributo autônomo na declaração XML.

Retornos

XmlDeclaration

O novo nó XmlDeclaration.

Exceções

ArgumentException

Os valores de version ou standalone são diferentes daqueles especificados acima.

Exemplos

O exemplo a seguir cria uma declaração XML e a adiciona ao 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

Comentários

Os atributos são expostos como propriedades especiais no XmlDeclaration nó e não como XmlAttribute nós.

Embora esse método crie o novo objeto no contexto do documento, ele não adiciona automaticamente o novo objeto à árvore de documentos. Para adicionar o novo objeto, você deve chamar explicitamente um dos métodos de inserção de nó.

De acordo com a recomendação do W3C Extensible Markup Language (XML) 1.0, o XmlDeclaration nó deve ser o primeiro nó no documento.

Esse método é uma extensão Microsoft para o DOM (Modelo de Objeto do Documento).

Confira também

• XmlDeclaration