SimpleXmlWriter class
Eine einfache und schnelle XML-Schreibklasse, die es einfach macht, eine XML-Zeichenfolge effizient zu erstellen.
Konstruktoren
Simple |
Methoden
clear() | Löscht alle Daten im XML-Writer und legt sich so fest, dass er zum Schreiben eines neuen Dokuments verwendet wird. |
to |
Schließt das Dokument und gibt eine Zeichenfolgenversion des XML-Dokuments zurück. |
write |
Schreibt einen Inhaltswert innerhalb eines CData-Tags. |
write |
Schreibt einen Kommentar im Dokument. |
write |
Schreibt ein vollständiges Tag-Element. |
write |
Schreibt alle verbleibenden schließenden Tag im Tagnamensstapel so, dass das Dokument geschlossen wird. |
write |
Schreibt das schließende Tag des letzten Tags, das geöffnet wurde. |
write |
Startet ein XML-Dokument. |
write |
Schreiben Sie ein Tag-Element. |
write |
Schreibt einen Zeichenfolgenwert. |
write |
Schreibt einen Wert in XML-Writer. |
Details zum Konstruktor
SimpleXmlWriter(boolean, string, string)
new SimpleXmlWriter(prettyPrint?: boolean, newLineChars?: string, indentChars?: string)
Parameter
- prettyPrint
-
boolean
Ein boolescher Wert, der angibt, ob das generierte XML formatiert und neue Zeilen und Einzuge verwendet.
Standardwert: true
.
- newLineChars
-
string
Die Zu verwendenden Zeichen zum Erstellen einer neuen Zeile in den XML-Daten.
Standardwert: "\r\n"
- indentChars
-
string
Die Zeichen, die zum Erstellen eines Einzugs in die XML-Daten verwendet werden sollen.
Standardwert: "\t"
Details zur Methode
clear()
Löscht alle Daten im XML-Writer und legt sich so fest, dass er zum Schreiben eines neuen Dokuments verwendet wird.
function clear()
toString()
Schließt das Dokument und gibt eine Zeichenfolgenversion des XML-Dokuments zurück.
function toString(): string
Gibt zurück
string
writeCDataContent(string)
Schreibt einen Inhaltswert innerhalb eines CData-Tags.
function writeCDataContent(content: string): SimpleXmlWriter
Parameter
- content
-
string
Der zu schreibende Inhaltswert.
Gibt zurück
writeComment(string)
Schreibt einen Kommentar im Dokument.
function writeComment(comment: string): SimpleXmlWriter
Parameter
- comment
-
string
Der Kommentar, der zum Dokument hinzugefügt werden soll.
Gibt zurück
writeElement(string, any, Record<string, string>)
Schreibt ein vollständiges Tag-Element.
function writeElement(name: string, content: any, attributes?: Record<string, string>): SimpleXmlWriter
Parameter
- name
-
string
Der Name des Tagelements.
- content
-
any
Der Inhalt des Tagelements.
- attributes
-
Record<string, string>
Die Attribute für das Tag.
Gibt zurück
writeEndDocument(boolean)
Schreibt alle verbleibenden schließenden Tag im Tagnamensstapel so, dass das Dokument geschlossen wird.
function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter
Parameter
- addTrailingNewLineChar
-
boolean
Ein boolescher Wert, der angibt, ob ein nachgestelltes neues Zeilenzeichen hinzugefügt oder nicht hinzugefügt werden soll.
Standardwert: true
Gibt zurück
writeEndElement(boolean)
Schreibt das schließende Tag des letzten Tags, das geöffnet wurde.
function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter
Parameter
- skipNewLine
-
boolean
Ein boolescher Wert, der angibt, ob das neue Zeilenzeichen nach dem schließenden Tag nicht hinzugefügt werden sollte.
Standardwert: false
.
Gibt zurück
writeStartDocument(boolean, string, boolean)
Startet ein XML-Dokument.
function writeStartDocument(includeEncodingTag?: boolean, encoding?: string, standalone?: boolean): SimpleXmlWriter
Parameter
- includeEncodingTag
-
boolean
Gibt an, ob das Codierungstag dem Dokument hinzugefügt werden soll. Standardwert: TRUE.
- encoding
-
string
Der Zeichenfolgencodierungswert des Dokuments.
- standalone
-
boolean
Ein boolescher Wert, der angibt, ob das XML-Dokument eigenständige oder nicht ist.
Gibt zurück
writeStartElement(string, Record<string, string | number>, boolean, boolean)
Schreiben Sie ein Tag-Element.
function writeStartElement(name: string, attributes?: Record<string, string | number>, selfClosing?: boolean, skipIndent?: boolean): SimpleXmlWriter
Parameter
- name
-
string
Der Name dieses Tags.
- attributes
-
Record<string, string | number>
Die Attribute für dieses Tag.
- selfClosing
-
boolean
Ein boolescher Wert, der angibt, ob dieses Tag selbst geschlossen oder nicht geschlossen werden soll.
- skipIndent
-
boolean
Gibt zurück
writeString(string, boolean)
Schreibt einen Zeichenfolgenwert.
function writeString(value: string, validate?: boolean): SimpleXmlWriter
Parameter
- value
-
string
Der zu schreibende Zeichenfolgenwert.
- validate
-
boolean
Ein boolescher Wert, der angibt, ob der Autor die Zeichenfolge so schreiben sollte, dass es sich um eine Überprüfung und Escape von Sonderzeichen handelt.
Gibt zurück
writeValue(any)
Schreibt einen Wert in XML-Writer.
function writeValue(value: any): SimpleXmlWriter
Parameter
- value
-
any
Jeder Wert, der geschrieben werden soll.