Obxecto obxecto incorporado

ObjectXmlComment

Os obxectos XmlComment representan o contido dos nodos de comentarios do documento

O nodo XmlComment representa un comentario nun documento XML. Usado porXmlCharacterDataO atributo de datos herdado pola interface ou mediante oXmlNodeO atributo nodeValue herdado pola interface pode acceder ao contido da anotación. (é dicir, o texto entre ). Usado porXmlCharacterDataVarios métodos herdados da interface poden operar sobre o contido da anotación.

usarXmlDocument.createComment() para crear un obxecto de anotación.

relación de herdanza

propiedades dos membros

data

String, o texto contido neste nodo

1
String XmlComment.data;

length

Enteiro, o número de caracteres contidos neste nodo

1
readonly Integer XmlComment.length;

nodeType

Enteiro, devolve o tipo de nodo do nodo

1
readonly Integer XmlComment.nodeType;

O nodeType de diferentes obxectos devolverá valores diferentes:


nodeName

String, devolve o nome do nodo, segundo o seu tipo

1
readonly String XmlComment.nodeName;

O nodeName de diferentes obxectos devolverá valores diferentes:


nodeValue

String, devolve o nome do nodo, segundo o seu tipo

1
String XmlComment.nodeValue;

O nodeName de diferentes obxectos devolverá valores diferentes:


ownerDocument

XmlDocument, devolve o elemento raíz do nodo (XmlDocumentobxecto)

1
readonly XmlDocument XmlComment.ownerDocument;

parentNode

XmlNode, pode devolver o nodo pai dun nodo

1
readonly XmlNode XmlComment.parentNode;

childNodes

XmlNodeList, devolve a lista de nodos dos nodos fillos do nodo especificado

1
readonly XmlNodeList XmlComment.childNodes;

children

XmlNodeList, devolve a lista de nodos dos nodos do elemento fillo do nodo especificado.

1
readonly XmlNodeList XmlComment.children;

firstChild

XmlNode, devolve o primeiro nodo fillo do nodo

1
readonly XmlNode XmlComment.firstChild;

lastChild

XmlNode, devolve o último nodo fillo do nodo

1
readonly XmlNode XmlComment.lastChild;

previousSibling

XmlNode, devolve o nodo inmediatamente anterior a un nodo (no mesmo nivel de árbore). Se non hai tal nodo, esta propiedade devolve nulo.

1
readonly XmlNode XmlComment.previousSibling;

nextSibling

XmlNode, devolve o nodo inmediatamente despois dun elemento (no mesmo nivel de árbore). Se non hai tal nodo, o atributo devolve nulo.

1
readonly XmlNode XmlComment.nextSibling;

firstElementChild

XmlNode, devolve o primeiro nodo do elemento fillo do nodo

1
readonly XmlNode XmlComment.firstElementChild;

lastElementChild

XmlNode, devolve o último nodo do elemento fillo do nodo

1
readonly XmlNode XmlComment.lastElementChild;

previousElementSibling

XmlNode, devolve o nodo do elemento inmediatamente anterior a un nodo (no mesmo nivel de árbore). Se non hai tal nodo, esta propiedade devolve nulo.

1
readonly XmlNode XmlComment.previousElementSibling;

nextElementSibling

XmlNode, devolve o nodo do elemento inmediatamente despois dun elemento (no mesmo nivel de árbore). Se non hai tal nodo, o atributo devolve nulo.

1
readonly XmlNode XmlComment.nextElementSibling;

textContent

Cadena, consulta e establece o texto do elemento seleccionado. Ao consultar, devolve os valores de todos os nodos de texto dentro do nodo de elemento; ao configurar, elimina todos os nodos fillos e substitúeos por un único nodo de texto.

1
String XmlComment.textContent;

función de membro

substringData

Extrae subcadea do nodo

1 2
String XmlComment.substringData(Integer offset, Integer count);

Parámetros de chamada:

  • offset: Enteiro, a posición do primeiro carácter que se devolverá
  • count: Enteiro, o número de caracteres da subcadea que se devolverá

Resultados de devolución:

  • String, devolve a cadea extraída

appendData

Engadir cadea ao nodo

1
XmlComment.appendData(String arg);

Parámetros de chamada:

  • arg: String, a cadea que se vai engadir ao nodo

insertData

Inserir cadea no nodo

1 2
XmlComment.insertData(Integer offset, String arg);

Parámetros de chamada:

  • offset: Enteiro, a posición do carácter na que se debe inserir a cadea no nodo
  • arg: String, a cadea que se vai inserir

deleteData

Eliminar texto do nodo

1 2
XmlComment.deleteData(Integer offset, Integer count);

Parámetros de chamada:

  • offset: Enteiro, a posición do primeiro carácter que se vai eliminar
  • count: Número enteiro, o número de caracteres a eliminar

replaceData

Substitúe os caracteres do nodo pola cadea especificada

1 2 3
XmlComment.replaceData(Integer offset, Integer count, String arg);

Parámetros de chamada:

  • offset: Enteiro, a posición do carácter do nodo que se vai substituír
  • count: Enteiro, o número de caracteres a substituír
  • arg: String, a cadea que se vai inserir

hasChildNodes

Consulta se hai nós fillos

1
Boolean XmlComment.hasChildNodes();

Resultados de devolución:

  • Boolean, devolve verdadeiro se hai algún nodo fillo, se non, devolve falso

normalize

Combina os nós de Texto adxacentes e elimina os nós de Texto baleiros

1
XmlComment.normalize();

Este método atravesará todos os nodos descendentes do nodo actual e normalizará o documento eliminando os nós de Texto baleiros e fusionando todos os nós de Texto adxacentes. Este método é útil para simplificar a estrutura da árbore do documento despois de inserir ou eliminar nós.


cloneNode

Crea unha copia exacta do nodo especificado

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

Parámetros de chamada:

  • deep: Booleano, se debe copiar en profundidade, cando é verdadeiro, o nodo clonado clonará todos os nodos fillos do nodo orixinal

Resultados de devolución:

Este método copiará e devolverá unha copia do nodo no que foi chamado. Se o argumento que se lle pasou é verdadeiro, tamén copiará de forma recursiva todos os nodos descendentes do nodo actual. En caso contrario, só copia o nodo actual. O nodo devolto non pertence á árbore do documento e a súa propiedade parentNode é nula. Cando se copia un nodo Element, copiaranse todas as súas propiedades.


lookupPrefix

Devolve o prefixo que coincide co URI de espazo de nomes especificado no nodo actual

1
String XmlComment.lookupPrefix(String namespaceURI);

Parámetros de chamada:

  • namespaceURI: Cadea, especifica o URI do espazo de nomes coincidente

Resultados de devolución:

  • String, devolve o prefixo coincidente, devolve nulo se non coincide.

lookupNamespaceURI

Devolve o URI do espazo de nomes que coincide co prefixo especificado no nodo actual

1
String XmlComment.lookupNamespaceURI(String prefix);

Parámetros de chamada:

  • prefix: Cadea, especifica o prefixo coincidente

Resultados de devolución:

  • String, devolve o URI do espazo de nomes coincidente, devolve nulo se non coincide.

insertBefore

Insira un novo nodo fillo antes dun nodo fillo existente

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

Parámetros de chamada:

  • newChild:XmlNode, inserir un novo nodo
  • refChild:XmlNode, inserir un novo nodo antes deste nodo

Resultados de devolución:

  • XmlNode, devolve o novo nodo fillo

Se xa existe newChild na árbore de documentos, eliminarase da árbore de documentos e reinserirase na súa nova posición. Os nós dun documento (ou os nodos creados por un documento) non se poden inserir noutro documento. É dicir, o atributo ownerDocument de newChild debe ser o mesmo que o atributo ownerDocument do nodo actual.


insertAfter

Insira un novo nodo fillo despois dun nodo fillo existente

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

Parámetros de chamada:

  • newChild:XmlNode, inserir un novo nodo
  • refChild:XmlNode, insira un novo nodo despois deste nodo

Resultados de devolución:

  • XmlNode, devolve o novo nodo fillo

Se xa existe newChild na árbore de documentos, eliminarase da árbore de documentos e reinserirase na súa nova posición. Os nós dun documento (ou os nodos creados por un documento) non se poden inserir noutro documento. É dicir, o atributo ownerDocument de newChild debe ser o mesmo que o atributo ownerDocument do nodo actual.


appendChild

Engade un novo nodo fillo ao final da lista de nodos fillos dun nodo

1
XmlNode XmlComment.appendChild(XmlNode newChild);

Parámetros de chamada:

  • newChild:XmlNode, especifique o nodo engadido

Resultados de devolución:

  • XmlNode, devolve este novo nodo fillo

Se xa existe newChild na árbore de documentos, eliminarase da árbore de documentos e reinserirase na súa nova posición. Os nós dun documento (ou os nodos creados por un documento) non se poden inserir noutro documento. É dicir, o atributo ownerDocument de newChild debe ser o mesmo que o atributo ownerDocument do nodo actual.


replaceChild

Substitúe un nodo fillo por outro

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

Parámetros de chamada:

  • newChild:XmlNode, especifique o novo nodo
  • oldChild:XmlNode, especifica o nodo que se vai substituír

Resultados de devolución:

  • XmlNode, Se a substitución ten éxito, este método pode devolver o nodo substituído. Se a substitución falla, devolve nulo.

Se xa existe newChild na árbore de documentos, eliminarase da árbore de documentos e reinserirase na súa nova posición. Os nós dun documento (ou os nodos creados por un documento) non se poden inserir noutro documento. É dicir, o atributo ownerDocument de newChild debe ser o mesmo que o atributo ownerDocument do nodo actual.


removeChild

Elimina un nodo da lista de nodos fillos

1
XmlNode XmlComment.removeChild(XmlNode oldChild);

Parámetros de chamada:

  • oldChild:XmlNode, especifica o nodo que se vai eliminar

Resultados de devolución:

  • XmlNode, Se a eliminación é correcta, este método pode devolver o nodo eliminado. Se falla, devolve nulo.

toString

Devolve a representación en cadea do obxecto. Polo xeral, devólvese "[Obxecto nativo]". O obxecto pódese volver implementar segundo as súas propias características.

1
String XmlComment.toString();

Resultados de devolución:

  • String, devolve a representación en cadea do obxecto

toJSON

Devolve unha representación en formato JSON do obxecto, devolvendo xeralmente unha colección de propiedades lexibles definidas polo obxecto.

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

Parámetros de chamada:

  • key: Cadena, non usada

Resultados de devolución:

  • Value, devolve un valor que contén JSON serializable