SimpleXmlWriter class

Balíček:

azure-maps-spatial-io

Jednoduchá a rychlá třída zápisu XML, která usnadňuje efektivní sestavení řetězce XML.

Konstruktory

SimpleXmlWriter(boolean, string, string)

Metody

clear()	Vymaže všechna data v zapisovači XML a nastaví se tak, aby se používala k zápisu nového dokumentu.
toString()	Zavře dokument a vrátí řetězcovou verzi dokumentu XML.
writeCDataContent(string)	Zapíše hodnotu obsahu uvnitř značky CData.
writeComment(string)	Zapíše komentář do dokumentu.
writeElement(string, any, Record<string, string>)	Zapíše úplný prvek značky.
writeEndDocument(boolean)	Zapíše všechny zbývající koncové značky do zásobníku názvů značek, aby se dokument zavřel.
writeEndElement(boolean)	Zapíše pravou značku poslední značky, která byla otevřena.
writeStartDocument(boolean, string, boolean)	Spustí dokument XML.
writeStartElement(string, Record<string, string | number>, boolean, boolean)	Napište prvek značky.
writeString(string, boolean)	Zapíše řetězcovou hodnotu.
writeValue(any)	Zapíše hodnotu do zapisovače XML.

Podrobnosti konstruktoru

SimpleXmlWriter(boolean, string, string)

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

Parametry

prettyPrint

boolean

Logická hodnota označující, jestli má být vygenerovaný XML formátovaný, a používat nové řádky a odsazení. Výchozí: true.

newLineChars

string

Znaky, které se mají použít k vytvoření nového řádku v datech XML. Výchozí: "\r\n"

indentChars

string

Znaky, které se mají použít k vytvoření odsazení v datech XML. Výchozí: "\t"

Podrobnosti metody

clear()

Vymaže všechna data v zapisovači XML a nastaví se tak, aby se používala k zápisu nového dokumentu.

function clear()

toString()

Zavře dokument a vrátí řetězcovou verzi dokumentu XML.

function toString(): string

Návraty

string

writeCDataContent(string)

Zapíše hodnotu obsahu uvnitř značky CData.

function writeCDataContent(content: string): SimpleXmlWriter

Parametry

content

string

Hodnota obsahu k zápisu.

Návraty

SimpleXmlWriter

writeComment(string)

Zapíše komentář do dokumentu.

function writeComment(comment: string): SimpleXmlWriter

Parametry

comment

string

Komentář, který chcete do dokumentu napsat.

Návraty

SimpleXmlWriter

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

Zapíše úplný prvek značky.

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

Parametry

name

string

Název elementu značky.

content

any

Obsah elementu značky.

attributes

Record<string, string>

Atributy značky.

Návraty

SimpleXmlWriter

writeEndDocument(boolean)

Zapíše všechny zbývající koncové značky do zásobníku názvů značek, aby se dokument zavřel.

function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter

Parametry

addTrailingNewLineChar

boolean

Logická hodnota označující, jestli se má přidat koncový znak nového řádku nebo ne. Výchozí: true

Návraty

SimpleXmlWriter

writeEndElement(boolean)

Zapíše pravou značku poslední značky, která byla otevřena.

function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter

Parametry

skipNewLine

boolean

Logická hodnota označující, jestli by se nový znak řádku neměl přidat za pravou značku. Výchozí: false.

Návraty

SimpleXmlWriter

writeStartDocument(boolean, string, boolean)

Spustí dokument XML.

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

Parametry

includeEncodingTag

boolean

Určuje, jestli má být značka kódování přidána do dokumentu. Výchozí hodnota: Pravda.

encoding

string

Hodnota kódování řetězce dokumentu.

standalone

boolean

Logická hodnota označující, jestli je dokument XML samostatný nebo ne.

Návraty

SimpleXmlWriter

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

Napište prvek značky.

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

Parametry

name

string

Název této značky.

attributes

Record<string, string | number>

Atributy této značky.

selfClosing

boolean

Logická hodnota označující, jestli by tato značka měla být samozavírací nebo ne.

skipIndent

boolean

Návraty

SimpleXmlWriter

writeString(string, boolean)

Zapíše řetězcovou hodnotu.

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

Parametry

value

string

Hodnota řetězce pro zápis.

validate

boolean

Logická hodnota označující, jestli by zapisovač měl zapsat řetězec tak, jak je, nebo ověřit a utéct speciálních znaků.

Návraty

SimpleXmlWriter

writeValue(any)

Zapíše hodnotu do zapisovače XML.

function writeValue(value: any): SimpleXmlWriter

Parametry

value

any

Libovolná hodnota, která se má zapsat.

Návraty

SimpleXmlWriter