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

Definição

Namespace:
System.Xml
Assemblies:
System.Xml.dll, System.Xml.XmlDocument.dll
Assemblies:
netstandard.dll, System.Xml.ReaderWriter.dll
Assembly:
System.Xml.XmlDocument.dll
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll
Origem:
XmlDocument.cs
Origem:
XmlDocument.cs
Origem:
XmlDocument.cs
Origem:
XmlDocument.cs
Origem:
XmlDocument.cs

Cria um XmlDeclaration nó 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);
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 que é usada quando você salva em XmlDocument um arquivo ou um fluxo; portanto, ela deve ser definida como uma cadeia de caracteres com suporte pela Encoding classe, caso contrário Save(String) , falha. Se isso for null ou String.Empty, o Save método não gravará um atributo de codificação na declaração XML e, portanto, a codificação padrão, UTF-8, será usada.

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

standalone
String

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

Retornos

XmlDeclaration

O novo XmlDeclaration nó.

Exceções

ArgumentException

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

Exemplos

O exemplo a seguir cria uma declaração XML e a adiciona ao documento.

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 XML (Linguagem de Marcação Extensível) 1.0 do W3C, o XmlDeclaration nó deve ser o primeiro nó no documento.

Esse método é uma extensão Microsoft para o DOM (Document Object Model).

Aplica-se a

Confira também