Object XmlDocument

El objeto XmlDocument representa el documento XML completo

El objeto XmlDocument es la raíz de un árbol de documentos y nos proporciona acceso inicial (o superior) a los datos del documento. Los nodos de elementos, nodos de texto, comentarios, instrucciones de procesamiento, etc. no pueden existir fuera de XmlDocument. Los objetos XmlDocument también proporcionan métodos para crear estos objetos. XmlNode objetos XmlNode proporcionan una propiedad ownerDocument que los asocia con el XmlDocument en el que se crearon.

Herencia

Constructor

XmlDocument

Construir un objeto XmlDocument

1
new XmlDocument(String type = "text/xml");

Parámetros de llamada:

• type : String, especifica el tipo de objeto del documento. El valor predeterminado es "text / xml ". Si necesita procesar html, debe especificar "text / html"

Atributos del miembro

inputEncoding

Cadena, devuelve la codificación utilizada para el documento (al analizar)

1
readonly String XmlDocument.inputEncoding;

xmlStandalone

Booleano, establece o devuelve si el documento es independiente

1
Boolean XmlDocument.xmlStandalone;

xmlVersion

Cadena, establece o devuelve la versión XML del documento.

1
String XmlDocument.xmlVersion;

doctype

XmlDocumentType , devuelve la declaración de tipo de documento relacionada con el documento

1
readonly XmlDocumentType XmlDocument.doctype;

Para documentos XML sin DTD, se devuelve un valor nulo. Esta propiedad proporciona acceso directo a un objeto XmlDocumentType (un elemento secundario de XmlDocument).

documentElement

XmlElement , devuelve el nodo raíz del documento

1
readonly XmlElement XmlDocument.documentElement;

head

XmlElement , devuelve el nodo principal de un documento HTML, solo válido en modo html

1
readonly XmlElement XmlDocument.head;

title

Cadena, devuelve el contenido del nodo de título del documento HTML, solo válido en modo html

1
readonly String XmlDocument.title;

body

XmlElement , devuelve el nodo del cuerpo de un documento HTML, solo válido en modo html

1
readonly XmlElement XmlDocument.body;

nodeType

Entero, devuelve el tipo de nodo del nodo

1
readonly Integer XmlDocument.nodeType;

El nodeType de diferentes objetos devolverá diferentes valores:

• XmlElement : ELEMENT_NODE (1)
• XmlAttr : XmlAttr (2)
• XmlText : TEXT_NODE (3)
• XmlCDATASection : CDATA_SECTION_NODE (4)
• XmlProcessingInstruction : PROCESSING_INSTRUCTION_NODE (7)
• XmlComment : COMMENT_NODE (8)
• XmlDocument : DOCUMENT_NODE (9)
• XmlDocumentType : DOCUMENT_TYPE_NODE (10)

nodeName

Cadena, devuelve el nombre del nodo, según su tipo

1
readonly String XmlDocument.nodeName;

El nodeName de diferentes objetos devolverá diferentes valores:

• XmlElement : nombre del elemento
• XmlAttr : nombre de atributo
• XmlText : #text
• XmlCDATASection : # cdata-section
• XmlProcessingInstruction : devuelve el objetivo especificado
• XmlComment : # comentario
• XmlDocument : #document
• XmlDocumentType : nombre del doctype

nodeValue

Cadena, devuelve el nombre del nodo, según su tipo

1
String XmlDocument.nodeValue;

El nodeName de diferentes objetos devolverá diferentes valores:

• XmlElement : nulo
• XmlAttr : el valor del atributo
• XmlText : el contenido del nodo
• XmlCDATASection : el contenido del nodo
• XmlProcessingInstruction : devuelve los datos de contenido especificados
• XmlComment : texto de comentario
• XmlDocument : nulo
• XmlDocumentType : null

ownerDocument

XmlDocument, devuelve el elemento raíz del nodo (objeto XmlDocument)

1
readonly XmlDocument XmlDocument.ownerDocument;

parentNode

XmlNode , que puede devolver el padre de un nodo

1
readonly XmlNode XmlDocument.parentNode;

childNodes

XmlNodeList , devuelve la lista de nodos de los hijos del nodo especificado

1
readonly XmlNodeList XmlDocument.childNodes;

firstChild

XmlNode , devuelve el primer hijo del nodo

1
readonly XmlNode XmlDocument.firstChild;

lastChild

XmlNode , devuelve el último hijo del nodo

1
readonly XmlNode XmlDocument.lastChild;

previousSibling

XmlNode , devuelve el nodo inmediatamente antes de un nodo (en el mismo nivel de árbol), si no existe dicho nodo, la propiedad devuelve nulo

1
readonly XmlNode XmlDocument.previousSibling;

nextSibling

XmlNode , devuelve el nodo inmediatamente después de un elemento (en el mismo nivel de árbol), o nulo si no existe dicho nodo

1
readonly XmlNode XmlDocument.nextSibling;

Función miembro

load

Redacte el documento analizando una cadena XML / HTML. Multilingüe no es compatible

1
XmlDocument.load(String source);

Parámetros de llamada:

• source : Cadena, el texto XML / HTML a analizar, según el tipo cuando se creó el documento

El documento se compone al analizar una cadena binaria XML / HTML y se convierte automáticamente según el idioma

1
XmlDocument.load(Buffer source);

Parámetros de llamada:

• source : Buffer , texto XML / HTML para analizar, dependiendo del tipo cuando se creó el documento

getElementsByTagName

Devuelve una lista de nodos con todos los elementos con el nombre especificado

1
XmlNodeList XmlDocument.getElementsByTagName(String tagName);

Parámetros de llamada:

• tagName : String, el nombre de la etiqueta que se va a recuperar. El valor "*" coincide con todas las etiquetas

Devuelve el resultado:

• XmlNodeList , la estructura del documento con la etiqueta especificada XmlElement nodos XmlNodeList conjunto. El orden de los nodos de elementos devueltos es el orden en que aparecen en el documento fuente.

Este método devolverá un objeto XmlNodeList (que puede manejarse como una matriz de solo lectura). Este objeto almacena todos los nodos XmlElement con el nombre de etiqueta especificado en el documento. El orden en que se almacenan es el orden en que aparecen en el documento fuente. XmlNodeList objeto XmlNodeList es "en vivo", es decir, si el elemento con el nombre de etiqueta especificado se agrega o elimina del documento, su contenido se actualizará automáticamente según sea necesario.

getElementsByTagNameNS

Devuelve una lista de nodos con todos los elementos del espacio de nombres y nombre especificados

1
2
XmlNodeList XmlDocument.getElementsByTagNameNS(String namespaceURI,
    String localName);

Parámetros de llamada:

• namespaceURI : String, especifica el URI del espacio de nombres para recuperar. El valor "*" coincide con todas las etiquetas
• localName : String, el nombre de la etiqueta que se va a recuperar. El valor "*" coincide con todas las etiquetas

Devuelve el resultado:

• XmlNodeList , la estructura del documento con la etiqueta especificada XmlElement nodos XmlNodeList conjunto. El orden de los nodos de elementos devueltos es el orden en que aparecen en el documento fuente.

Este método es similar al método getElementsByTagName (), excepto que recupera elementos basados ​​en el espacio de nombres y el nombre.

getElementById

Devuelve el elemento con el atributo id especificado

1
XmlElement XmlDocument.getElementById(String id);

Parámetros de llamada:

• id : String, el id a recuperar

Devuelve el resultado:

• XmlElement , árbol de nodos con el atributo especificado Identificación XmlElement nodo

Este método iterará a través de los nodos descendientes del documento y devolverá un objeto de nodo XmlElement que representa el primer elemento del documento con el atributo id especificado. .

getElementsByClassName

Devuelve una lista de nodos de todos los elementos con el nombre de clase especificado

1
XmlNodeList XmlDocument.getElementsByClassName(String className);

Parámetros de llamada:

• className : String, el nombre de la clase que se va a recuperar

Devuelve el resultado:

• XmlNodeList , la estructura del documento con el nombre de la clase especificada XmlElement nodos XmlNodeList colección. El orden de los nodos de elementos devueltos es el orden en que aparecen en el documento fuente.

Este método devolverá un objeto XmlNodeList (que puede tratarse como una matriz de solo lectura). Este objeto almacena todos los nodos XmlElement con el nombre de clase especificado en el documento. El orden en que se almacenan es el orden en que aparecen en el documento fuente. XmlNodeList objeto XmlNodeList es "en vivo", es decir, si el elemento con el nombre de etiqueta especificado se agrega o elimina del documento, su contenido se actualizará automáticamente según sea necesario.

createElement

Crear nodo de elemento

1
XmlElement XmlDocument.createElement(String tagName);

Parámetros de llamada:

• tagName : String, el nombre especificado del nodo del elemento especificado

Devuelve el resultado:

• XmlElement , devuelve el nodo XmlElement recién creado con el nombre de etiqueta especificado

createElementNS

Crear un nodo de elemento con el espacio de nombres especificado

1
2
XmlElement XmlDocument.createElementNS(String namespaceURI,
    String qualifiedName);

Parámetros de llamada:

• namespaceURI : String, especifica el URI del espacio de nombres del nodo del elemento
• qualifiedName : String, el nombre especificado del nodo del elemento especificado

Devuelve el resultado:

• XmlElement , devuelve el nodo XmlElement recién creado con el nombre de etiqueta especificado

createTextNode

Crear nodo de texto

1
XmlText XmlDocument.createTextNode(String data);

Parámetros de llamada:

• data : String, especifica el texto de este nodo

Devuelve el resultado:

• XmlText , devuelve el nodo XmlText recién creado, que representa la cadena de datos especificada

createComment

Crear nodo de anotación

1
XmlComment XmlDocument.createComment(String data);

Parámetros de llamada:

• data : String, especifica el texto del comentario para este nodo

Devuelve el resultado:

• XmlComment , devuelve el nodo XmlComment recién creado, el texto del comentario son los datos especificados

createCDATASection

Crear nodo XmlCDATASection

1
XmlCDATASection XmlDocument.createCDATASection(String data);

Parámetros de llamada:

• data : String, especifica que este nodo especifica datos CDATA

Devuelve el resultado:

• XmlCDATASection , devuelve el nodo XmlCDATASection recién creado con los datos especificados

createProcessingInstruction

Crear nodo XmlProcessingInstruction

1
2
XmlProcessingInstruction XmlDocument.createProcessingInstruction(String target,
    String data);

Parámetros de llamada:

• target : String, especifica el objetivo de la instrucción de procesamiento
• data : String, el texto de la instrucción de procesamiento especificada

Devuelve el resultado:

• XmlProcessingInstruction , el nodo ProcessingInstruction recién creado

hasChildNodes

Consulta si hay nodos secundarios

1
Boolean XmlDocument.hasChildNodes();

Devuelve el resultado:

• Boolean , devuelve verdadero si hay nodos secundarios, de lo contrario devuelve falso

normalize

Fusionar nodos de texto adyacentes y eliminar nodos de texto vacíos

1
XmlDocument.normalize();

Este método recorrerá todos los nodos descendientes del nodo actual y normalizará el documento eliminando los nodos de texto vacíos y fusionando todos los nodos de texto adyacentes. Este método es útil para simplificar la estructura del árbol de documentos después de insertar o eliminar nodos.

cloneNode

Crea una copia exacta del nodo especificado

1
XmlNode XmlDocument.cloneNode(Boolean deep = true);

Parámetros de llamada:

• deep : booleano, si se debe copiar profundamente. Cuando es verdadero, el nodo clonado clonará a todos los hijos del nodo original.

Devuelve el resultado:

• XmlNode , devuelve el nodo copiado

Este método copia y devuelve una copia del nodo que lo llamó. Si el argumento pasado es verdadero, también copiará recursivamente todos los nodos descendientes del nodo actual. De lo contrario, solo copia el nodo actual. El nodo devuelto no pertenece al árbol de documentos y su propiedad parentNode es nula. Cuando se copia un nodo Elemento, se copian todos sus atributos.

lookupPrefix

Devuelve el prefijo que coincide con el URI del espacio de nombres especificado en el nodo actual

1
String XmlDocument.lookupPrefix(String namespaceURI);

Parámetros de llamada:

• namespaceURI : String, especifica el URI del espacio de nombres coincidente

Devuelve el resultado:

• String , devuelve el prefijo coincidente, devuelve nulo si no coincide

lookupNamespaceURI

Devuelve el URI del espacio de nombres que coincide con el prefijo especificado en el nodo actual

1
String XmlDocument.lookupNamespaceURI(String prefix);

Parámetros de llamada:

• prefix : Cadena, especifique el prefijo coincidente

Devuelve el resultado:

• String , devuelve URI de espacio de nombres coincidente, devuelve nulo si no coincide

insertBefore

Inserte un nuevo nodo hijo antes del nodo hijo existente

1
2
XmlNode XmlDocument.insertBefore(XmlNode newChild,
    XmlNode refChild);

Parámetros de llamada:

• newChild : XmlNode , inserte un nuevo nodo
• refChild : XmlNode , inserte un nuevo nodo antes de este nodo

Devuelve el resultado:

• XmlNode , devuelve un nuevo nodo hijo

Si newChild ya existe en el árbol de documentos, se eliminará del árbol de documentos y luego se reinsertará en su nueva posición. Los nodos de un documento (o nodos creados a partir de un documento) no se pueden insertar en otro documento. Es decir, la propiedad ownerDocument de newChild debe ser la misma que la propiedad ownerDocument del nodo actual.

insertAfter

Insertar un nuevo nodo secundario después de un nodo secundario existente

1
2
XmlNode XmlDocument.insertAfter(XmlNode newChild,
    XmlNode refChild);

Parámetros de llamada:

• newChild : XmlNode , inserte un nuevo nodo
• refChild : XmlNode , inserte un nuevo nodo después de este nodo

Devuelve el resultado:

• XmlNode , devuelve un nuevo nodo hijo

Si newChild ya existe en el árbol de documentos, se eliminará del árbol de documentos y luego se reinsertará en su nueva posición. Los nodos de un documento (o nodos creados a partir de un documento) no se pueden insertar en otro documento. Es decir, la propiedad ownerDocument de newChild debe ser la misma que la propiedad ownerDocument del nodo actual.

appendChild

Agregue un nuevo nodo secundario al final de la lista de nodos secundarios del nodo

1
XmlNode XmlDocument.appendChild(XmlNode newChild);

Parámetros de llamada:

• newChild : XmlNode , especifique el nodo agregado

Devuelve el resultado:

• XmlNode , devuelve este nuevo nodo hijo

Si newChild ya existe en el árbol de documentos, se eliminará del árbol de documentos y luego se reinsertará en su nueva posición. Los nodos de un documento (o nodos creados a partir de un documento) no se pueden insertar en otro documento. Es decir, la propiedad ownerDocument de newChild debe ser la misma que la propiedad ownerDocument del nodo actual.

replaceChild

Reemplace un nodo hijo con otro

1
2
XmlNode XmlDocument.replaceChild(XmlNode newChild,
    XmlNode oldChild);

Parámetros de llamada:

• newChild : XmlNode , especifique un nuevo nodo
• oldChild : XmlNode , especifique el nodo que se reemplazará

Devuelve el resultado:

• XmlNode , si el reemplazo es exitoso, este método puede devolver el nodo reemplazado, si el reemplazo falla, devolver nulo

Si newChild ya existe en el árbol de documentos, se eliminará del árbol de documentos y luego se reinsertará en su nueva posición. Los nodos de un documento (o nodos creados a partir de un documento) no se pueden insertar en otro documento. Es decir, la propiedad ownerDocument de newChild debe ser la misma que la propiedad ownerDocument del nodo actual.

removeChild

Eliminar un nodo de la lista de nodos secundarios

1
XmlNode XmlDocument.removeChild(XmlNode oldChild);

Parámetros de llamada:

• oldChild : XmlNode , especifique el nodo que se eliminará

Devuelve el resultado:

• XmlNode , si la eliminación es exitosa, este método puede devolver el nodo eliminado, si falla, devuelve nulo

toString

Devuelve una representación de cadena del objeto, generalmente "[Objeto nativo]". Los objetos se pueden volver a implementar de acuerdo con sus propias características

1
String XmlDocument.toString();

Devuelve el resultado:

• String , devuelve una representación de cadena del objeto

toJSON

Devuelve una representación JSON del objeto, que generalmente devuelve una colección de propiedades legibles definidas por el objeto

1
Value XmlDocument.toJSON(String key = "");

Parámetros de llamada:

• key : cadena, sin usar

Devuelve el resultado:

• Value , devuelve un valor que contiene un JSON serializable