SimpleXmlWriter class

Paquet:

azure-maps-spatial-io

Classe d’écriture XML simple et rapide qui facilite la création efficace d’une chaîne XML.

Constructeurs

SimpleXmlWriter(boolean, string, string)

Méthodes

clear()	Efface toutes les données de l’enregistreur XML et se définit pour être utilisées pour écrire un nouveau document.
toString()	Ferme le document et retourne une version de chaîne du document XML.
writeCDataContent(string)	Écrit une valeur de contenu à l’intérieur d’une balise CData.
writeComment(string)	Écrit un commentaire dans le document.
writeElement(string, any, Record<string, string>)	Écrit un élément de balise complet.
writeEndDocument(boolean)	Écrit toute la balise de fermeture restante dans la pile de noms de balise afin de fermer le document.
writeEndElement(boolean)	Écrit la balise de fermeture de la dernière balise ouverte.
writeStartDocument(boolean, string, boolean)	Démarre un document XML.
writeStartElement(string, Record<string, string | number>, boolean, boolean)	Écrivez un élément de balise.
writeString(string, boolean)	Écrit une valeur de chaîne.
writeValue(any)	Écrit une valeur dans l’enregistreur XML.

Détails du constructeur

SimpleXmlWriter(boolean, string, string)

new SimpleXmlWriter(prettyPrint?: boolean, newLineChars?: string, indentChars?: string)

Paramètres

prettyPrint

boolean

Valeur booléenne indiquant si le code XML généré doit être mis en forme et utiliser de nouvelles lignes et retraits. Par défaut : true.

newLineChars

string

Caractères à utiliser pour créer une ligne dans les données XML. Valeur par défaut : "\r\n"

indentChars

string

Caractères à utiliser pour créer un retrait dans les données XML. Valeur par défaut : "\t"

Détails de la méthode

clear()

Efface toutes les données de l’enregistreur XML et se définit pour être utilisées pour écrire un nouveau document.

function clear()

toString()

Ferme le document et retourne une version de chaîne du document XML.

function toString(): string

Retours

string

writeCDataContent(string)

Écrit une valeur de contenu à l’intérieur d’une balise CData.

function writeCDataContent(content: string): SimpleXmlWriter

Paramètres

content

string

Valeur de contenu à écrire.

Retours

SimpleXmlWriter

writeComment(string)

Écrit un commentaire dans le document.

function writeComment(comment: string): SimpleXmlWriter

Paramètres

comment

string

Commentaire à ajouter au document.

Retours

SimpleXmlWriter

writeElement(string, any, Record<string, string>)

Écrit un élément de balise complet.

function writeElement(name: string, content: any, attributes?: Record<string, string>): SimpleXmlWriter

Paramètres

name

string

Nom de l’élément de balise.

content

any

Contenu de l’élément de balise.

attributes

Record<string, string>

Attributs de la balise.

Retours

SimpleXmlWriter

writeEndDocument(boolean)

Écrit toute la balise de fermeture restante dans la pile de noms de balise afin de fermer le document.

function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter

Paramètres

addTrailingNewLineChar

boolean

Valeur booléenne indiquant si un caractère de ligne de fin doit être ajouté ou non. Valeur par défaut : true

Retours

SimpleXmlWriter

writeEndElement(boolean)

Écrit la balise de fermeture de la dernière balise ouverte.

function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter

Paramètres

skipNewLine

boolean

Valeur booléenne indiquant si le nouveau caractère de ligne ne doit pas être ajouté après la balise de fermeture. Par défaut : false.

Retours

SimpleXmlWriter

writeStartDocument(boolean, string, boolean)

Démarre un document XML.

function writeStartDocument(includeEncodingTag?: boolean, encoding?: string, standalone?: boolean): SimpleXmlWriter

Paramètres

includeEncodingTag

boolean

Spécifie si la balise d’encodage doit être ajoutée au document. Valeur par défaut : True.

encoding

string

Valeur d’encodage de chaîne du document.

standalone

boolean

Valeur booléenne indiquant si le document XML est autonome ou non.

Retours

SimpleXmlWriter

writeStartElement(string, Record<string, string | number>, boolean, boolean)

Écrivez un élément de balise.

function writeStartElement(name: string, attributes?: Record<string, string | number>, selfClosing?: boolean, skipIndent?: boolean): SimpleXmlWriter

Paramètres

name

string

Nom de cette balise.

attributes

Record<string, string | number>

Attributs de cette balise.

selfClosing

boolean

Valeur booléenne indiquant si cette balise doit être auto-fermante ou non.

skipIndent

boolean

Retours

SimpleXmlWriter

writeString(string, boolean)

Écrit une valeur de chaîne.

function writeString(value: string, validate?: boolean): SimpleXmlWriter

Paramètres

value

string

Valeur de chaîne à écrire.

validate

boolean

Valeur booléenne indiquant si l’enregistreur doit écrire la chaîne telle quelle, ou valider et échapper des caractères spéciaux.

Retours

SimpleXmlWriter

writeValue(any)

Écrit une valeur dans l’enregistreur XML.

function writeValue(value: any): SimpleXmlWriter

Paramètres

value

any

Toute valeur à écrire.

Retours

SimpleXmlWriter