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 节点公开。

尽管此方法在文档上下文中创建新对象，但它不会自动将新对象添加到文档树。 若要添加新对象，必须显式调用其中一个节点插入方法。

根据 W3C 可扩展标记语言 (XML) 1.0 建议，节点 XmlDeclaration 必须是文档中的第一个节点。

此方法是文档对象模型 (DOM) 的 Microsoft 扩展。

另请参阅

• XmlDeclaration