Condividi tramite


SimpleXmlWriter class

Classe di scrittura XML semplice e veloce che semplifica la compilazione di una stringa XML.

Costruttori

SimpleXmlWriter(boolean, string, string)

Metodi

clear()

Cancella tutti i dati nel writer XML e imposta se stesso per scrivere un nuovo documento.

toString()

Chiude il documento e restituisce una versione stringa del documento XML.

writeCDataContent(string)

Scrive un valore di contenuto all'interno di un tag CData.

writeComment(string)

Scrive un commento nel documento.

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

Scrive un elemento tag completo.

writeEndDocument(boolean)

Scrive tutto il tag di chiusura rimanente nello stack di nomi del tag in modo da chiudere il documento.

writeEndElement(boolean)

Scrive il tag di chiusura dell'ultimo tag aperto.

writeStartDocument(boolean, string, boolean)

Avvia un documento XML.

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

Scrivere un elemento tag.

writeString(string, boolean)

Scrive un valore stringa.

writeValue(any)

Scrive un valore nel writer XML.

Dettagli costruttore

SimpleXmlWriter(boolean, string, string)

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

Parametri

prettyPrint

boolean

Valore booleano che indica se il codice XML generato deve essere formattato e utilizzare nuove righe e rientri. Impostazione predefinita: true.

newLineChars

string

Caratteri da utilizzare per creare una nuova riga nei dati XML. Valore predefinito: "\r\n"

indentChars

string

Caratteri da utilizzare per creare un rientro nei dati XML. Valore predefinito: "\t"

Dettagli metodo

clear()

Cancella tutti i dati nel writer XML e imposta se stesso per scrivere un nuovo documento.

function clear()

toString()

Chiude il documento e restituisce una versione stringa del documento XML.

function toString(): string

Restituisce

string

writeCDataContent(string)

Scrive un valore di contenuto all'interno di un tag CData.

function writeCDataContent(content: string): SimpleXmlWriter

Parametri

content

string

Valore del contenuto da scrivere.

Restituisce

writeComment(string)

Scrive un commento nel documento.

function writeComment(comment: string): SimpleXmlWriter

Parametri

comment

string

Commento da scrivere per aggiungere al documento.

Restituisce

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

Scrive un elemento tag completo.

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

Parametri

name

string

Nome dell'elemento tag.

content

any

Contenuto dell'elemento tag.

attributes

Record<string, string>

Attributi per il tag.

Restituisce

writeEndDocument(boolean)

Scrive tutto il tag di chiusura rimanente nello stack di nomi del tag in modo da chiudere il documento.

function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter

Parametri

addTrailingNewLineChar

boolean

Valore booleano che indica se è necessario aggiungere o meno un nuovo carattere di riga finale. Valore predefinito: true

Restituisce

writeEndElement(boolean)

Scrive il tag di chiusura dell'ultimo tag aperto.

function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter

Parametri

skipNewLine

boolean

Valore booleano che indica se il nuovo carattere di riga non deve essere aggiunto dopo il tag di chiusura. Impostazione predefinita: false.

Restituisce

writeStartDocument(boolean, string, boolean)

Avvia un documento XML.

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

Parametri

includeEncodingTag

boolean

Specifica se il tag di codifica deve essere aggiunto al documento. Predefinito: True.

encoding

string

Valore di codifica della stringa del documento.

standalone

boolean

Valore booleano che indica se il documento XML è autonomo o meno.

Restituisce

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

Scrivere un elemento tag.

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

Parametri

name

string

Nome del tag.

attributes

Record<string, string | number>

Attributi per questo tag.

selfClosing

boolean

Valore booleano che indica se questo tag deve essere di chiusura automatica o meno.

skipIndent

boolean

Restituisce

writeString(string, boolean)

Scrive un valore stringa.

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

Parametri

value

string

Valore stringa da scrivere.

validate

boolean

Valore booleano che indica se il writer deve scrivere la stringa così com'è oppure convalidare e eseguire l'escape di caratteri speciali.

Restituisce

writeValue(any)

Scrive un valore nel writer XML.

function writeValue(value: any): SimpleXmlWriter

Parametri

value

any

Qualsiasi valore da scrivere.

Restituisce