SimpleXmlWriter class

Pakiet:

azure-maps-spatial-io

Prosta i szybka klasa zapisu XML, która ułatwia efektywne tworzenie ciągu XML.

Konstruktory

SimpleXmlWriter(boolean, string, string)

Metody

clear()	Czyści wszystkie dane w składniku zapisywania XML i konfiguruje się tak, aby były używane do pisania nowego dokumentu.
toString()	Zamyka dokument i zwraca wersję ciągu dokumentu XML.
writeCDataContent(string)	Zapisuje wartość zawartości wewnątrz tagu CData.
writeComment(string)	Zapisuje komentarz w dokumencie.
writeElement(string, any, Record<string, string>)	Zapisuje kompletny element tagu.
writeEndDocument(boolean)	Zapisuje cały pozostały tag zamykający w stosie nazw tagów, aby zamknąć dokument.
writeEndElement(boolean)	Zapisuje tag zamykający ostatniego otwartego tagu.
writeStartDocument(boolean, string, boolean)	Uruchamia dokument XML.
writeStartElement(string, Record<string, string | number>, boolean, boolean)	Napisz element tagu.
writeString(string, boolean)	Zapisuje wartość ciągu.
writeValue(any)	Zapisuje wartość w składniku zapisywania XML.

Szczegóły konstruktora

SimpleXmlWriter(boolean, string, string)

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

Parametry

prettyPrint

boolean

Wartość logiczna wskazująca, czy wygenerowany kod XML powinien być sformatowany i używać nowych wierszy i wcięcia. Wartość domyślna: true.

newLineChars

string

Znaki używane do utworzenia nowego wiersza w danych XML. Domyślny: "\r\n"

indentChars

string

Znaki używane do tworzenia wcięcia w danych XML. Domyślny: "\t"

Szczegóły metody

clear()

Czyści wszystkie dane w składniku zapisywania XML i konfiguruje się tak, aby były używane do pisania nowego dokumentu.

function clear()

toString()

Zamyka dokument i zwraca wersję ciągu dokumentu XML.

function toString(): string

Zwraca

string

writeCDataContent(string)

Zapisuje wartość zawartości wewnątrz tagu CData.

function writeCDataContent(content: string): SimpleXmlWriter

Parametry

content

string

Wartość zawartości do zapisania.

Zwraca

SimpleXmlWriter

writeComment(string)

Zapisuje komentarz w dokumencie.

function writeComment(comment: string): SimpleXmlWriter

Parametry

comment

string

Komentarz do zapisu w dokumencie.

Zwraca

SimpleXmlWriter

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

Zapisuje kompletny element tagu.

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

Parametry

name

string

Nazwa elementu tagu.

content

any

Zawartość elementu tagu.

attributes

Record<string, string>

Atrybuty tagu.

Zwraca

SimpleXmlWriter

writeEndDocument(boolean)

Zapisuje cały pozostały tag zamykający w stosie nazw tagów, aby zamknąć dokument.

function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter

Parametry

addTrailingNewLineChar

boolean

Wartość logiczna wskazująca, czy powinien zostać dodany końcowy znak nowego wiersza. Domyślny: true

Zwraca

SimpleXmlWriter

writeEndElement(boolean)

Zapisuje tag zamykający ostatniego otwartego tagu.

function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter

Parametry

skipNewLine

boolean

Wartość logiczna wskazująca, czy nowy znak wiersza nie powinien być dodawany po tagu zamykającym. Wartość domyślna: false.

Zwraca

SimpleXmlWriter

writeStartDocument(boolean, string, boolean)

Uruchamia dokument XML.

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

Parametry

includeEncodingTag

boolean

Określa, czy tag kodowania powinien zostać dodany do dokumentu. Wartość domyślna: True.

encoding

string

Wartość kodowania ciągu dokumentu.

standalone

boolean

Wartość logiczna wskazująca, czy dokument XML jest autonomiczny, czy nie.

Zwraca

SimpleXmlWriter

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

Napisz element tagu.

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

Parametry

name

string

Nazwa tego tagu.

attributes

Record<string, string | number>

Atrybuty tego tagu.

selfClosing

boolean

Wartość logiczna wskazująca, czy ten tag powinien być zamykany samodzielnie, czy nie.

skipIndent

boolean

Zwraca

SimpleXmlWriter

writeString(string, boolean)

Zapisuje wartość ciągu.

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

Parametry

value

string

Wartość ciągu do zapisania.

validate

boolean

Wartość logiczna wskazująca, czy składnik zapisywania powinien zapisywać ciąg w takiej postaci, czy sprawdza poprawność i ucieczkę znaków specjalnych.

Zwraca

SimpleXmlWriter

writeValue(any)

Zapisuje wartość w składniku zapisywania XML.

function writeValue(value: any): SimpleXmlWriter

Parametry

value

any

Każda wartość, która ma zostać zapisana.

Zwraca

SimpleXmlWriter