你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
SimpleXmlWriter class
一个简单且快速的 XML 编写类,可轻松地生成 XML 字符串。
构造函数
Simple |
方法
clear() | 清除 XML 编写器中的所有数据,并将自身设置为用于编写新文档。 |
to |
关闭文档并返回 XML 文档的字符串版本。 |
write |
在 CData 标记内写入内容值。 |
write |
在文档中编写注释。 |
write |
写入完整的标记元素。 |
write |
写入标记名称堆栈中的所有剩余结束标记,以便关闭文档。 |
write |
写入打开的最后一个标记的结束标记。 |
write |
启动 XML 文档。 |
write |
编写标记元素。 |
write |
写入字符串值。 |
write |
将值写入 XML 编写器。 |
构造函数详细信息
SimpleXmlWriter(boolean, string, string)
new SimpleXmlWriter(prettyPrint?: boolean, newLineChars?: string, indentChars?: string)
参数
- prettyPrint
-
boolean
一个布尔值,指示是否应格式化生成的 XML 并使用新行和缩进。
默认值:true
。
- newLineChars
-
string
用于在 XML 数据中创建新行的字符。
默认:"\r\n"
- indentChars
-
string
用于在 XML 数据中创建缩进的字符。
默认:"\t"
方法详细信息
clear()
清除 XML 编写器中的所有数据,并将自身设置为用于编写新文档。
function clear()
toString()
关闭文档并返回 XML 文档的字符串版本。
function toString(): string
返回
string
writeCDataContent(string)
在 CData 标记内写入内容值。
function writeCDataContent(content: string): SimpleXmlWriter
参数
- content
-
string
要写入的内容值。
返回
writeComment(string)
在文档中编写注释。
function writeComment(comment: string): SimpleXmlWriter
参数
- comment
-
string
要添加到文档的注释。
返回
writeElement(string, any, Record<string, string>)
写入完整的标记元素。
function writeElement(name: string, content: any, attributes?: Record<string, string>): SimpleXmlWriter
参数
- name
-
string
标记元素的名称。
- content
-
any
标记元素的内容。
- attributes
-
Record<string, string>
标记的属性。
返回
writeEndDocument(boolean)
写入标记名称堆栈中的所有剩余结束标记,以便关闭文档。
function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter
参数
- addTrailingNewLineChar
-
boolean
一个布尔值,指示是否应添加尾随的新行字符。
默认:true
返回
writeEndElement(boolean)
写入打开的最后一个标记的结束标记。
function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter
参数
- skipNewLine
-
boolean
一个布尔值,指示在结束标记之后是否不应添加新行字符。
默认值:false
。
返回
writeStartDocument(boolean, string, boolean)
启动 XML 文档。
function writeStartDocument(includeEncodingTag?: boolean, encoding?: string, standalone?: boolean): SimpleXmlWriter
参数
- includeEncodingTag
-
boolean
指定是否应将编码标记添加到文档中。 默认值:True。
- encoding
-
string
文档的字符串编码值。
- standalone
-
boolean
一个布尔值,指示 XML 文档是否独立。
返回
writeStartElement(string, Record<string, string | number>, boolean, boolean)
编写标记元素。
function writeStartElement(name: string, attributes?: Record<string, string | number>, selfClosing?: boolean, skipIndent?: boolean): SimpleXmlWriter
参数
- name
-
string
此标记的名称。
- attributes
-
Record<string, string | number>
此标记的属性。
- selfClosing
-
boolean
一个布尔值,指示此标记是否应为自关闭。
- skipIndent
-
boolean
返回
writeString(string, boolean)
写入字符串值。
function writeString(value: string, validate?: boolean): SimpleXmlWriter
参数
- value
-
string
要写入的字符串值。
- validate
-
boolean
一个布尔值,指示编写器是否应按原样写入字符串,或验证和转义特殊字符。
返回
writeValue(any)
将值写入 XML 编写器。
function writeValue(value: any): SimpleXmlWriter
参数
- value
-
any
要写入的任何值。