System.Xml.XmlDocument.CreateXmlDeclaration 方法
方法描述
创建一个具有指定值的 XmlDeclaration 节点。
语法定义(C# System.Xml.XmlDocument.CreateXmlDeclaration 方法 的用法)
public virtual XmlDeclaration CreateXmlDeclaration( string version, string encoding, string standalone )
参数/返回值
| 参数值/返回值 | 参数类型/返回类型 | 参数描述/返回描述 |
|---|---|---|
| version | System-String | 版本必须为“1.0”。 |
| encoding | System-String | 编码方式特性的值。这是当将 XmlDocument 保存到文件或流时使用的编码方式；因此必须将其设置为 Encoding 类支持的字符串，否则 Save 失败。如果这是 null 或 String.Empty，则 Save 方法不在 XML 声明上写出编码方式特性，因此将使用默认的编码方式 UTF-8。注意：如果将 XmlDocument 保存到 TextWriter 或 XmlTextWriter，则放弃该编码值。而改用 TextWriter 或 XmlTextWriter 的编码方式。这确保可以使用正确的编码方式读回写出的 XML。 |
| standalone | System-String | 该值必须是“yes”或“no”。如果这是 null 或 String.Empty，Save 方法不在 XML 声明上写出独立特性。 |
| 返回值 | System.Xml.XmlDeclaration | 新的 XmlDeclaration 节点。 |
提示和注释
该特性公开为 XmlDeclaration 节点上的特殊属性，而不公开为 XmlAttribute 节点。
尽管此方法在文档的上下文中创建新对象，但它并不自动将新对象添加到文档树。 若要添加新对象，必须显式调用节点插入方法之一。
根据 W3C 可扩展标记语言 (XML) 1.0 建议 (www.w3.org/TR/1998/REC-xml-19980210)，XmlDeclaration 节点必须是文档中的第一个节点。
该方法是文档对象模型 (DOM) 的 Microsoft 扩展。
System.Xml.XmlDocument.CreateXmlDeclaration 方法例子
下面的示例创建一个 XML 声明并将其添加到文档中。
using System;
using System.IO;
using System.Xml;
public class Sample
{
public static void Main()
{
XmlDocument doc = new XmlDocument();
doc.LoadXml("" +
"Pride And Prejudice " +
" ");
//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);
}
}
异常
| 异常 | 异常描述 |
|---|---|
| ArgumentException | version 或 standalone 的值是上面所指定的值以外的值。 |
版本信息
.NET Framework 受以下版本支持：4、3.5、3.0、2.0、1.1、1.0 .NET Framework Client Profile 受以下版本支持：4、3.5 SP1
适用平台
Windows 7, Windows Vista SP1 或更高版本, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008（不支持服务器核心）, Windows Server 2008 R2（支持 SP1 或更高版本的服务器核心）, Windows Server 2003 SP2 .NET Framework 并不是对每个平台的所有版本都提供支持。有关支持的版本的列表，请参见.NET Framework 系统要求。