XmlWriterSettings 类

定义

命名空间:

System.Xml

程序集:

System.Xml.ReaderWriter.dll

程序集:

System.Xml.dll

程序集:

netstandard.dll

指定在由 XmlWriter 方法创建的 Create 对象上支持的一组功能。

public ref class XmlWriterSettings sealed

public sealed class XmlWriterSettings

type XmlWriterSettings = class

Public NotInheritable Class XmlWriterSettings

继承

Object

XmlWriterSettings

示例

以下示例创建一个 XmlWriter ，用于写入 XML 文件，并在新行上写入每个属性。

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.OmitXmlDeclaration = true;
settings.NewLineOnAttributes = true;

writer = XmlWriter.Create(Console.Out, settings);

writer.WriteStartElement("order");
writer.WriteAttributeString("orderID", "367A54");
writer.WriteAttributeString("date", "2001-05-03");
writer.WriteElementString("price", "19.95");
writer.WriteEndElement();
    
writer.Flush();

        Dim settings As New XmlWriterSettings()
        settings.Indent = True
        settings.OmitXmlDeclaration = True
        settings.NewLineOnAttributes = True
   
        writer = XmlWriter.Create(Console.Out, settings)

        writer.WriteStartElement("order")
        writer.WriteAttributeString("orderID", "367A54")
        writer.WriteAttributeString("date", "2001-05-03")
        writer.WriteElementString("price", "19.95")
        writer.WriteEndElement()

        writer.Flush()

此示例生成以下输出：

<order
  orderID="367A54"
  date="2001-05-03">
  <price>19.95</price>
</order>

注解

方法 Create 是获取 XmlWriter 实例的首选机制。 方法 Create 使用 XmlWriterSettings 类指定要在创建的对象中 XmlWriter 实现哪些功能。

注意

如果将 对象与 方法一起使用XmlWriterTransform，则应使用 OutputSettings 属性获取XmlWriterSettings具有正确设置的对象。 这样可以确保所创建的 XmlWriter 对象的输出设置是正确的。

类 XmlWriterSettings 提供用于控制数据一致性和输出格式的属性。

对于数据一致性检查和自动更正，请使用以下属性：

properties	指定	值	默认
CheckCharacters	是否检查字符是否位于 W3C 定义的合法 XML 字符集中。	true 或 false	true
ConformanceLevel	检查输出是否为格式正确的 XML 1.0 文档或片段。	ConformanceLevel.Document (文档级) 、 Fragment (片段级) 或 Auto (自动检测)	ConformanceLevel.Document (文档级一致性)
WriteEndDocumentOnClose	调用 方法时 Close ，是否向所有未关闭的元素添加结束标记。	true 或 false	true

若要指定输出格式，请使用以下属性：

properties	指定	值	默认
Encoding	要使用的文本编码。	System.Text.Encoding 值	Encoding.UTF8
Indent	是否缩进元素	true 或 false	false (无缩进)
IndentChars	缩进时使用的字符串 (设置为 Indenttrue) 。	String	两个空格
NewLineChars	用于换行符的字符串。	String	\r\n (回车、换行)
NewLineHandling	如何处理换行符。	System.Xml.NewLineHandling value： Entitize (规范化) 、 Replace (替换) 或 None (保持不变)	Replace (替换为) 指定的 NewLineChars 字符
NewLineOnAttributes	当) 时 Indentfalse ，是否在单个行上写入属性 (不起作用。	true 或 false	false
OmitXmlDeclaration	是否编写 XML 声明。	true 或 false	false

构造函数

XmlWriterSettings()

初始化 XmlWriterSettings 类的新实例。

属性

Async	获取或设置一个值，该值指示是否可对特定的 XmlWriter 实例使用异步 XmlWriter 方法。
CheckCharacters	获取或设置一个值，该值指示是否应检查 XML 编写器以确保文档中的所有字符都符合 W3C XML 1.0 建议中的“2.2 字符”部分。
CloseOutput	获取或设置一个值，该值指示调用 Close() 方法时 XmlWriter 是否也应关闭基础流或 TextWriter。
ConformanceLevel	获取或设置的 XML 写入器检查 XML 输出的一致性级别。
DoNotEscapeUriAttributes	获取或设置一个值，该值指示 XmlWriter 是否未转义 URI 属性。
Encoding	获取或设置要使用的文本编码的类型。
Indent	获取或设置指示是否缩进元素的值。
IndentChars	获取或设置缩进时要使用的字符串。 在 Indent 属性设置为 true 时使用此设置。
NamespaceHandling	获取或设置一个值，该值指示在写入 XML 内容时 XmlWriter 是否应移除重复的命名空间声明。 写入器的默认行为是输出写入器的命名空间解析程序中存在的所有命名空间声明。
NewLineChars	获取或设置要用于换行符的字符串。
NewLineHandling	获取或设置一个值，该值指示是否将输出中的换行符规范化。
NewLineOnAttributes	获取或设置一个值，该值指示是否在新行上写入属性。
OmitXmlDeclaration	获取或设置一个值，该值指示是否省略 XML 声明。
OutputMethod	获取用于串行化 XmlWriter 输出的方法。
WriteEndDocumentOnClose	获取或设置一个值，该值指示在调用 Close() 方法时 XmlWriter 是否会向所有未关闭的元素标记添加结束标记。

方法

Clone()	创建 XmlWriterSettings 实例的副本。
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
Reset()	将设置类的成员重置为各自的默认值。
ToString()	返回表示当前对象的字符串。 (继承自 Object)