SimpleXmlWriter class
Una clase de escritura XML sencilla y rápida que facilita la compilación eficaz de una cadena XML.
Constructores
Simple |
Métodos
clear() | Borra todos los datos del sistema de escritura XML y se configura para que se usen para escribir un nuevo documento. |
to |
Cierra el documento y devuelve una versión de cadena del documento XML. |
write |
Escribe un valor de contenido dentro de una etiqueta CData. |
write |
Escribe un comentario en el documento. |
write |
Escribe un elemento de etiqueta completo. |
write |
Escribe todas las etiquetas de cierre restantes en la pila de nombres de etiqueta para cerrar el documento. |
write |
Escribe la etiqueta de cierre de la última etiqueta que se abrió. |
write |
Inicia un documento XML. |
write |
Escriba un elemento de etiqueta. |
write |
Escribe un valor de cadena. |
write |
Escribe un valor en el sistema de escritura XML. |
Detalles del constructor
SimpleXmlWriter(boolean, string, string)
new SimpleXmlWriter(prettyPrint?: boolean, newLineChars?: string, indentChars?: string)
Parámetros
- prettyPrint
-
boolean
Valor booleano que indica si se debe dar formato al XML generado y usar nuevas líneas y sangrías.
Predeterminado: true
.
- newLineChars
-
string
Caracteres que se van a usar para crear una nueva línea en los datos XML.
Valor predeterminado: "\r\n"
- indentChars
-
string
Caracteres que se van a usar para crear una sangría en los datos XML.
Valor predeterminado: "\t"
Detalles del método
clear()
Borra todos los datos del sistema de escritura XML y se configura para que se usen para escribir un nuevo documento.
function clear()
toString()
Cierra el documento y devuelve una versión de cadena del documento XML.
function toString(): string
Devoluciones
string
writeCDataContent(string)
Escribe un valor de contenido dentro de una etiqueta CData.
function writeCDataContent(content: string): SimpleXmlWriter
Parámetros
- content
-
string
Valor de contenido que se va a escribir.
Devoluciones
writeComment(string)
Escribe un comentario en el documento.
function writeComment(comment: string): SimpleXmlWriter
Parámetros
- comment
-
string
Comentario que se va a escribir para agregar al documento.
Devoluciones
writeElement(string, any, Record<string, string>)
Escribe un elemento de etiqueta completo.
function writeElement(name: string, content: any, attributes?: Record<string, string>): SimpleXmlWriter
Parámetros
- name
-
string
Nombre del elemento de etiqueta.
- content
-
any
El contenido del elemento de etiqueta.
- attributes
-
Record<string, string>
Atributos de la etiqueta .
Devoluciones
writeEndDocument(boolean)
Escribe todas las etiquetas de cierre restantes en la pila de nombres de etiqueta para cerrar el documento.
function writeEndDocument(addTrailingNewLineChar?: boolean): SimpleXmlWriter
Parámetros
- addTrailingNewLineChar
-
boolean
Valor booleano que indica si se debe agregar o no un carácter de línea nuevo final.
Valor predeterminado: true
Devoluciones
writeEndElement(boolean)
Escribe la etiqueta de cierre de la última etiqueta que se abrió.
function writeEndElement(skipNewLine?: boolean): SimpleXmlWriter
Parámetros
- skipNewLine
-
boolean
Valor booleano que indica si no se debe agregar el nuevo carácter de línea después de la etiqueta de cierre.
Predeterminado: false
.
Devoluciones
writeStartDocument(boolean, string, boolean)
Inicia un documento XML.
function writeStartDocument(includeEncodingTag?: boolean, encoding?: string, standalone?: boolean): SimpleXmlWriter
Parámetros
- includeEncodingTag
-
boolean
Especifica si la etiqueta de codificación se debe agregar al documento. Valor predeterminado: True.
- encoding
-
string
Valor de codificación de cadena del documento.
- standalone
-
boolean
Valor booleano que indica si el documento XML es independiente o no.
Devoluciones
writeStartElement(string, Record<string, string | number>, boolean, boolean)
Escriba un elemento de etiqueta.
function writeStartElement(name: string, attributes?: Record<string, string | number>, selfClosing?: boolean, skipIndent?: boolean): SimpleXmlWriter
Parámetros
- name
-
string
Nombre de esta etiqueta.
- attributes
-
Record<string, string | number>
Atributos de esta etiqueta.
- selfClosing
-
boolean
Valor booleano que indica si esta etiqueta debe cerrarse automáticamente o no.
- skipIndent
-
boolean
Devoluciones
writeString(string, boolean)
Escribe un valor de cadena.
function writeString(value: string, validate?: boolean): SimpleXmlWriter
Parámetros
- value
-
string
Valor de cadena que se va a escribir.
- validate
-
boolean
Valor booleano que indica si el escritor debe escribir la cadena tal cual, o validar y escape de caracteres especiales.
Devoluciones
writeValue(any)
Escribe un valor en el sistema de escritura XML.
function writeValue(value: any): SimpleXmlWriter
Parámetros
- value
-
any
Cualquier valor que se va a escribir.