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

Определение

Пространство имен:
System.Xml
Сборки:
System.Xml.dll, System.Xml.XmlDocument.dll
Сборки:
netstandard.dll, System.Xml.ReaderWriter.dll
Сборка:
System.Xml.XmlDocument.dll
Сборка:
System.Xml.ReaderWriter.dll
Сборка:
System.Xml.dll
Сборка:
netstandard.dll
Исходный код:
XmlDocument.cs
Исходный код:
XmlDocument.cs
Исходный код:
XmlDocument.cs
Исходный код:
XmlDocument.cs
Исходный код:
XmlDocument.cs

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 кодирования сохранено в a TextWriter или an XmlTextWriter, это значение кодирования удаляется. Вместо этого используется кодировка TextWriter или используется XmlTextWriter . Это гарантирует, что xml-код, записанный, можно считывать обратно с помощью правильной кодировки.

standalone
String

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

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

XmlDeclaration

Новый XmlDeclaration узел.

Исключения

ArgumentException

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

Примеры

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

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 узлы.

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

В соответствии с рекомендацией W3C XmlDeclaration узел должен быть первым узлом в документе.

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

Применяется к

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