SimpleXmlWriter class

Pacote:

azure-maps-spatial-io

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

Construtores

SimpleXmlWriter(boolean, string, string)

Métodos

clear()	Limpa todos os dados no gravador XML e se configura para ser usado para gravar um novo documento.
toString()	Fecha o documento e retorna uma versão de cadeia de caracteres do documento XML.
writeCDataContent(string)	Grava um valor de conteúdo dentro de uma marca CData.
writeComment(string)	Grava um comentário no documento.
writeElement(string, any, Record<string, string>)	Grava um elemento de marca completa.
writeEndDocument(boolean)	Grava toda a marca de fechamento restante na pilha de nomes de marca para fechar o documento.
writeEndElement(boolean)	Grava a marca de fechamento da última marca que foi aberta.
writeStartDocument(boolean, string, boolean)	Inicia um documento XML.
writeStartElement(string, Record<string, string | number>, boolean, boolean)	Escreva um elemento de marca.
writeString(string, boolean)	Grava um valor de cadeia de caracteres.
writeValue(any)	Grava um valor no gravador XML.

Detalhes do construtor

SimpleXmlWriter(boolean, string, string)

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

Parâmetros

prettyPrint

boolean

Um booliano que indica se o XML gerado deve ser formatado e usar novas linhas e recuos. Padrão: true.

newLineChars

string

Os caracteres a serem usados para criar uma nova linha nos dados XML. Padrão: "\r\n"

indentChars

string

Os caracteres a serem usados para criar um recuo nos dados XML. Padrão: "\t"

Detalhes do método

clear()

Limpa todos os dados no gravador XML e se configura para ser usado para gravar um novo documento.

function clear()

toString()

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

function toString(): string

Retornos

string

writeCDataContent(string)

Grava um valor de conteúdo dentro de uma marca CData.

function writeCDataContent(content: string): SimpleXmlWriter

Parâmetros

content

string

O valor do conteúdo a ser gravado.

Retornos

SimpleXmlWriter

writeComment(string)

Grava um comentário no documento.

function writeComment(comment: string): SimpleXmlWriter

Parâmetros

comment

string

O comentário a ser gravado adicionado ao documento.

Retornos

SimpleXmlWriter

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

Grava um elemento de marca completa.

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

Parâmetros

name

string

O nome do elemento de marca.

content

any

O conteúdo do elemento tag.

attributes

Record<string, string>

Os atributos da marca.

Retornos

SimpleXmlWriter

writeEndDocument(boolean)

Grava toda a marca de fechamento restante na pilha de nomes de marca para fechar o documento.

function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter

Parâmetros

addTrailingNewLineChar

boolean

Um booliano que indica se um novo caractere de linha à direita deve ser adicionado ou não. Padrão: true

Retornos

SimpleXmlWriter

writeEndElement(boolean)

Grava a marca de fechamento da última marca que foi aberta.

function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter

Parâmetros

skipNewLine

boolean

Um booliano que indica se o novo caractere de linha não deve ser adicionado após a marca de fechamento. Padrão: false.

Retornos

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 marca de codificação deve ser adicionada ao documento. Padrão: True.

encoding

string

O valor de codificação de cadeia de caracteres do documento.

standalone

boolean

Um booliano que indica se o documento XML é autônomo ou não.

Retornos

SimpleXmlWriter

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

Escreva um elemento de marca.

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

Parâmetros

name

string

O nome dessa marca.

attributes

Record<string, string | number>

Os atributos dessa marca.

selfClosing

boolean

Um booliano que indica se essa marca deve ser auto-fechamento ou não.

skipIndent

boolean

Retornos

SimpleXmlWriter

writeString(string, boolean)

Grava um valor de cadeia de caracteres.

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

Parâmetros

value

string

O valor da cadeia de caracteres a ser gravado.

validate

boolean

Um booliano que indica se o gravador deve escrever a cadeia de caracteres como está ou validar e escapar de caracteres especiais.

Retornos

SimpleXmlWriter

writeValue(any)

Grava um valor no gravador XML.

function writeValue(value: any): SimpleXmlWriter

Parâmetros

value

any

Qualquer valor a ser gravado.

Retornos

SimpleXmlWriter