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
要寫入的任何值。