XmlDocument.CreateXmlDeclaration(String, String, String) Метод

Определение

Пространство имен:

System.Xml

Сборки:

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

Сборка:

System.Xml.ReaderWriter.dll

Сборка:

System.Xml.XmlDocument.dll

Сборка:

System.Xml.dll

Сборка:

netstandard.dll

Создает узел XmlDeclaration с указанными значениями.

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

Параметры

version

String

Номер версии должен быть равен 1.0.

encoding

String

Значение атрибута кодировки. Эта кодировка используется при сохранении XmlDocument в файле или потоке, поэтому она должна быть задана как строка, поддерживаемая классом Encoding. В противном случае в работе Save(String) возникает сбой. Если она имеет значение null или String.Empty, метод Save не записывает атрибут кодировки в объявление XML и используется кодировка UTF-8, заданная по умолчанию.

Примечание. Если XmlDocument сохранен в TextWriter или XmlTextWriter, это значение кодировки не учитывается. Вместо нее используется кодировка TextWriter или XmlTextWriter . Таким образом обеспечивается возможность чтения записанного XML в правильной кодировке.

standalone

String

Значение должно быть равно "yes" или "no". Если значение равно null или String.Empty, метод Save не записывает в объявление XML отдельный атрибут.

Возвращаемое значение

XmlDeclaration

Новый узел XmlDeclaration.

Исключения

ArgumentException

Значения version или standalone немного отличаются от значений, указанных выше.

Примеры

В следующем примере создается xml-объявление и добавляется в документ.

#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

Комментарии

Атрибуты предоставляются как специальные свойства на XmlDeclaration узле, а не как XmlAttribute узлы.

Хотя этот метод создает новый объект в контексте документа, он не добавляет новый объект в дерево документов автоматически. Чтобы добавить новый объект, необходимо явно вызвать один из методов вставки узла.

В соответствии с рекомендацией XmlDeclaration W3C Extensible Markup Language (XML) 1.0 узел должен быть первым узлом в документе.

Этот метод является расширением Майкрософт для модели объектов документов (DOM).

См. также раздел

• XmlDeclaration