Aspose.Words Modelo de Objetos de documento (DOM)
El Aspose.Words Document Object Model (DOM) es una representación en memoria de un documento de Word. El Aspose.Words DOM le permite leer, manipular y modificar mediante programación el contenido y el formato de un documento de Word.
Esta sección describe las clases principales del Aspose.Words DOM y sus relaciones. Al usar las clases DOM Aspose.Words, puede obtener acceso programático a los elementos del documento y al formato.
Crear Árbol de Objetos de Documento
Cuando se lee un documento en el DOM Aspose.Words, se crea un árbol de objetos y los diferentes tipos de elementos del documento fuente tienen sus propios objetos de árbol DOM con varias propiedades.
Construir Árbol de Nodos de Documento
Cuando Aspose.Words lee un documento de Word en la memoria, crea objetos de diferentes tipos que representan varios elementos del documento. Cada ejecución de un texto, párrafo, tabla o sección es un nodo, e incluso el documento en sí mismo es un nodo. Aspose.Words define una clase para cada tipo de nodo de documento.
El árbol de documentos en Aspose.Words sigue el Patrón de Diseño Compuesto:
- En última instancia, todas las clases de nodo se derivan de la clase Node, que es la clase base en el Modelo de Objetos de documento Aspose.Words.
- Los nodos que pueden contener otros nodos, por ejemplo, Section o Paragraph, derivan de la clase CompositeNode, que a su vez deriva de la clase Node.
El diagrama que se proporciona a continuación muestra la herencia entre las clases de nodo del Modelo de Objetos de Documento (DOM) Aspose.Words. Los nombres de las clases abstractas están en cursiva.
Node.
Veamos un ejemplo. La siguiente imagen muestra un documento de Microsoft Word con diferentes tipos de contenido.
Al leer el documento anterior en el Aspose.Words DOM, se crea el árbol de objetos, como se muestra en el esquema a continuación.
Document, Section, Paragraph, Table, Shape, Run, y todas las demás elipses en el diagrama son Aspose.Words objetos que representan elementos del documento de Word.
Obtener un Node Tipo
Aunque la clase Node es suficiente para distinguir diferentes nodos entre sí, Aspose.Words proporciona la enumeración NodeType para simplificar algunas tareas de la API, como seleccionar nodos de un tipo específico.
El tipo de cada nodo se puede obtener utilizando la propiedad NodeType. Esta propiedad devuelve un NodeType enumeration value. For example, a paragraph node represented by the Paragraph class returns NodeType.Paragraph y un nodo de tabla representado por el Table class returns NodeType.Table.
El siguiente ejemplo muestra cómo obtener un tipo de nodo usando la enumeración NodeType:
Navegación del Árbol de Documentos
Aspose.Words representa un documento como un árbol de nodos, lo que le permite navegar entre nodos. En esta sección se describe cómo explorar y navegar por el árbol de documentos en Aspose.Words.
Cuando abre el documento de muestra, presentado anteriormente, en el Explorador de documentos, el árbol de nodos aparece exactamente como está representado en Aspose.Words.
Relaciones de Nodos de Documento
Los nodos del árbol tienen relaciones entre ellos:
- Un nodo que contiene otro nodo es un parent.
- El nodo contenido en el nodo primario es un child. Nodo secundario del mismo padre son sibling nodos.
- El nodo root es siempre el nodo Document.
Los nodos que pueden contener otros nodos derivan de la clase CompositeNode y, en última instancia, todos los nodos derivan de la clase Node. Estas dos clases base proporcionan métodos y propiedades comunes para la navegación y modificación de la estructura de árbol.
El siguiente diagrama de objetos UML muestra varios nodos del documento de muestra y sus relaciones entre sí a través de las propiedades padre, hijo y hermano:
El Documento es Propietario del Nodo
Un nodo siempre pertenece a un documento en particular, incluso si acaba de crearse o eliminarse del árbol, porque las estructuras vitales de todo el documento, como los estilos y las listas, se almacenan en el nodo Document. Por ejemplo, no es posible tener un Paragraph sin un Document porque cada párrafo tiene un estilo asignado que se define globalmente para el documento. Esta regla se usa al crear nuevos nodos. Agregar un nuevo Paragraph directamente al DOM requiere que se pase un objeto de documento al constructor.
Al crear un nuevo párrafo usando DocumentBuilder, el constructor siempre tiene una clase Document vinculada a él a través de la propiedad DocumentBuilder.Document.
El siguiente ejemplo de código muestra que al crear cualquier nodo, siempre se define un documento que será el propietario del nodo:
Nodo Padre
Cada nodo tiene un padre especificado por la propiedad ParentNode. Un nodo no tiene nodo padre, es decir, ParentNode es nulo, en los siguientes casos:
- El nodo acaba de crearse y aún no se ha agregado al árbol.
- El nodo se ha eliminado del árbol.
- Este es el nodo raíz Document que siempre tiene un nodo padre nulo.
Puede eliminar un nodo de su padre llamando al método Remove.El siguiente ejemplo de código muestra cómo acceder al nodo principal:
Nodos Secundarios
La forma más eficiente de acceder a los nodos secundarios de a CompositeNode es a través de las propiedades FirstChild y LastChild que devuelven el primer y el último nodo secundario, respectivamente. Si no hay nodos secundarios, estas propiedades devuelven null.
CompositeNode
Si un nodo no tiene hijos, la propiedad ChildNodes devuelve una colección vacía. Puede verificar si CompositeNode contiene nodos secundarios utilizando la propiedad HasChildNodes.
El siguiente ejemplo de código muestra cómo enumerar nodos secundarios inmediatos de un CompositeNode usando el enumerador proporcionado por la colección ChildNodes:
El siguiente ejemplo de código muestra cómo enumerar nodos secundarios inmediatos de un CompositeNode usando acceso indexado:
Nodos Hermanos
Puede obtener el nodo que precede o sigue inmediatamente a un nodo en particular utilizando las propiedades PreviousSibling y NextSibling, respectivamente. Si un nodo es el último hijo de su padre, entonces la propiedad NextSibling es null. Por el contrario, si el nodo es el primer hijo de su padre, la propiedad PreviousSibling es null.
El siguiente ejemplo de código muestra cómo visitar de manera eficiente todos los nodos secundarios directos e indirectos de un nodo compuesto:
Acceso escrito a Nodos Secundarios y Primarios
Hasta ahora, hemos discutido las propiedades que devuelven uno de los tipos base: Node o CompositeNode. Pero a veces hay situaciones en las que es posible que deba convertir valores a una clase de nodo específica, como Run o Paragraph. Es decir, no puede evitar por completo la conversión cuando trabaja con Aspose.Words DOM, que es compuesto.
Para reducir la necesidad de conversión, la mayoría de las clases Aspose.Words proporcionan propiedades y colecciones que proporcionan acceso fuertemente tipado. Hay tres patrones básicos de acceso mecanografiado:
- Un nodo primario expone las propiedades FirstXXX y LastXXX escritas. Por ejemplo, Document tiene FirstSection y LastSection propiedades. De manera similar, Table tiene propiedades como FirstRow, LastRow y otras.
- Un nodo primario expone una colección tipificada de nodos secundarios, como Document.Sections, Body.Paragraphs y otros.
- Un nodo secundario proporciona acceso escrito a su padre, como Run.ParentParagraph, Paragraph.ParentSection y otros.
Las propiedades escritas son simplemente accesos directos útiles que a veces brindan un acceso más fácil que las propiedades genéricas heredadas de Node.ParentNode y CompositeNode.FirstChild.
El siguiente ejemplo de código muestra cómo usar propiedades escritas para acceder a nodos del árbol de documentos: