Dela via


SimpleXmlWriter class

En enkel och snabb XML-skrivklass som gör det enkelt att effektivt skapa en XML-sträng.

Konstruktorer

SimpleXmlWriter(boolean, string, string)

Metoder

clear()

Rensar alla data i XML-skrivaren och konfigurerar sig för att användas för att skriva ett nytt dokument.

toString()

Stänger dokumentet och returnerar en strängversion av XML-dokumentet.

writeCDataContent(string)

Skriver ett innehållsvärde i en CData-tagg.

writeComment(string)

Skriver en kommentar i dokumentet.

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

Skriver ett fullständigt taggelement.

writeEndDocument(boolean)

Skriver alla återstående avslutande taggar i taggnamnstacken för att stänga dokumentet.

writeEndElement(boolean)

Skriver den avslutande taggen för den senaste taggen som öppnades.

writeStartDocument(boolean, string, boolean)

Startar ett XML-dokument.

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

Skriv ett taggelement.

writeString(string, boolean)

Skriver ett strängvärde.

writeValue(any)

Skriver ett värde till XML-skrivare.

Konstruktorinformation

SimpleXmlWriter(boolean, string, string)

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

Parametrar

prettyPrint

boolean

Ett booleskt värde som anger om den genererade XML-koden ska formateras och använda nya rader och indrag. Standard: true.

newLineChars

string

De tecken som ska användas för att skapa en ny rad i XML-data. Standard: "\r\n"

indentChars

string

De tecken som ska användas för att skapa ett indrag i XML-data. Standard: "\t"

Metodinformation

clear()

Rensar alla data i XML-skrivaren och konfigurerar sig för att användas för att skriva ett nytt dokument.

function clear()

toString()

Stänger dokumentet och returnerar en strängversion av XML-dokumentet.

function toString(): string

Returer

string

writeCDataContent(string)

Skriver ett innehållsvärde i en CData-tagg.

function writeCDataContent(content: string): SimpleXmlWriter

Parametrar

content

string

Innehållsvärdet som ska skrivas.

Returer

writeComment(string)

Skriver en kommentar i dokumentet.

function writeComment(comment: string): SimpleXmlWriter

Parametrar

comment

string

Kommentaren som ska skrivas lägger till i dokumentet.

Returer

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

Skriver ett fullständigt taggelement.

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

Parametrar

name

string

Namnet på taggelementet.

content

any

Innehållet i taggelementet.

attributes

Record<string, string>

Attributen för taggen.

Returer

writeEndDocument(boolean)

Skriver alla återstående avslutande taggar i taggnamnstacken för att stänga dokumentet.

function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter

Parametrar

addTrailingNewLineChar

boolean

Ett booleskt värde som anger om ett avslutande nytt radtecken ska läggas till eller inte. Standard: true

Returer

writeEndElement(boolean)

Skriver den avslutande taggen för den senaste taggen som öppnades.

function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter

Parametrar

skipNewLine

boolean

Ett booleskt värde som anger om det nya radtecknet inte ska läggas till efter den avslutande taggen. Standard: false.

Returer

writeStartDocument(boolean, string, boolean)

Startar ett XML-dokument.

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

Parametrar

includeEncodingTag

boolean

Anger om kodningstaggen ska läggas till i dokumentet. Standard: Sant.

encoding

string

Strängkodningsvärdet för dokumentet.

standalone

boolean

Ett booleskt värde som anger om XML-dokumentet är fristående eller inte.

Returer

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

Skriv ett taggelement.

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

Parametrar

name

string

Namnet på den här taggen.

attributes

Record<string, string | number>

Attributen för den här taggen.

selfClosing

boolean

Ett booleskt värde som anger om den här taggen ska vara självslutande eller inte.

skipIndent

boolean

Returer

writeString(string, boolean)

Skriver ett strängvärde.

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

Parametrar

value

string

Strängvärdet som ska skrivas.

validate

boolean

Ett booleskt värde som anger om skrivaren ska skriva strängen som den är eller validera och fly från specialtecken.

Returer

writeValue(any)

Skriver ett värde till XML-skrivare.

function writeValue(value: any): SimpleXmlWriter

Parametrar

value

any

Alla värden som ska skrivas.

Returer