SimpleXmlWriter class

Pacote:

azure-maps-spatial-io

Uma classe de escrita XML simples e rápida que facilita a construção eficiente de uma cadeia XML.

Construtores

SimpleXmlWriter(boolean, string, string)

Métodos

clear()	Limpa todos os dados do escritor XML e prepara-se para ser usado para escrever um novo documento.
toString()	Fecha o documento e devolve uma versão de cadeia do documento XML.
writeCDataContent(string)	Escreve um valor de conteúdo dentro de uma tag CData.
writeComment(string)	Escreve um comentário no documento.
writeElement(string, any, Record<string, string>)	Escreve um elemento de marcação completo.
writeEndDocument(boolean)	Escreve toda a etiqueta de fecho restante na pilha de nomes de etiquetas de modo a fechar o documento.
writeEndElement(boolean)	Escreve a etiqueta de fecho da última etiqueta que foi aberta.
writeStartDocument(boolean, string, boolean)	Inicia um documento XML.
writeStartElement(string, Record<string, string | number>, boolean, boolean)	Escreva um elemento de marcação.
writeString(string, boolean)	Escreve um valor de corda.
writeValue(any)	Escreve um valor para o escritor XML.

Detalhes do Construtor

SimpleXmlWriter(boolean, string, string)

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

Parâmetros

prettyPrint

boolean

Um boolean que indique se o XML gerado deve ser formatado e utilizar novas linhas e travessões. Predefinição: true.

newLineChars

string

Os caracteres para usar para criar uma nova linha nos dados XML. Predefinição: "\r\n"

indentChars

string

Os caracteres para usar para criar um travessão nos dados XML. Predefinição: "\t"

Detalhes de Método

clear()

Limpa todos os dados do escritor XML e prepara-se para ser usado para escrever um novo documento.

function clear()

toString()

Fecha o documento e devolve uma versão de cadeia do documento XML.

function toString(): string

Devoluções

string

writeCDataContent(string)

Escreve um valor de conteúdo dentro de uma tag CData.

function writeCDataContent(content: string): SimpleXmlWriter

Parâmetros

content

string

O valor do conteúdo para escrever.

Devoluções

SimpleXmlWriter

writeComment(string)

Escreve um comentário no documento.

function writeComment(comment: string): SimpleXmlWriter

Parâmetros

comment

string

O comentário a escrever acrescenta ao documento.

Devoluções

SimpleXmlWriter

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

Escreve um elemento de marcação completo.

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

Parâmetros

name

string

O nome do elemento tag.

content

any

O conteúdo do elemento tag.

attributes

Record<string, string>

Os atributos para a etiqueta.

Devoluções

SimpleXmlWriter

writeEndDocument(boolean)

Escreve toda a etiqueta de fecho restante na pilha de nomes de etiquetas de modo a fechar o documento.

function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter

Parâmetros

addTrailingNewLineChar

boolean

Um boolean que indique se um novo caracter de linha deve ser adicionado ou não. Predefinição: true

Devoluções

SimpleXmlWriter

writeEndElement(boolean)

Escreve a etiqueta de fecho da última etiqueta que foi aberta.

function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter

Parâmetros

skipNewLine

boolean

Um boolean que indique se o caractere da nova linha não deve ser adicionado após a etiqueta de fecho. Predefinição: false.

Devoluções

SimpleXmlWriter

writeStartDocument(boolean, string, boolean)

Inicia um documento XML.

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

Parâmetros

includeEncodingTag

boolean

Especifica se a etiqueta de codificação deve ser adicionada ao documento. Padrão: Verdade.

encoding

string

O valor codificante de cordas do documento.

standalone

boolean

Um booleano indicando se o documento XML é autónomo ou não.

Devoluções

SimpleXmlWriter

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

Escreva um elemento de marcação.

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

Parâmetros

name

string

O nome desta etiqueta.

attributes

Record<string, string | number>

Os atributos para esta etiqueta.

selfClosing

boolean

Um boolean que indique se esta etiqueta deve ser auto-fechada ou não.

skipIndent

boolean

Devoluções

SimpleXmlWriter

writeString(string, boolean)

Escreve um valor de corda.

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

Parâmetros

value

string

O valor da corda para escrever.

validate

boolean

Um booleano indicando se o escritor deve escrever a corda como está, ou validar e escapar de personagens especiais.

Devoluções

SimpleXmlWriter

writeValue(any)

Escreve um valor para o escritor XML.

function writeValue(value: any): SimpleXmlWriter

Parâmetros

value

any

Qualquer valor que seja escrito.

Devoluções

SimpleXmlWriter