Obtener el contenido de un elemento de documento de un paquete
En este tema se muestra cómo usar las clases del SDK de Open XML para Office para recuperar el contenido de un elemento de documento en un documento Wordprocessing mediante programación.
Partes de documento y paquetes
Un documento Office Open XML se almacena como un paquete, cuyo formato se define mediante ISO/IEC 29500-2. El paquete puede incluir varias partes con relaciones entre ellas. La relación entre las partes controla la categoría del documento. Un documento puede definirse como un documento de procesamiento de texto si su elemento de relación de paquete contiene una relación con una parte de documento principal. Si su elemento de relación de paquete contiene una relación con una parte de presentación, puede definirse como un documento de presentación. Si su elemento de relación de paquete contiene una relación con una parte de libro, se define como un documento de hoja de cálculo. En este tema sobre procedimientos se usará un paquete de documentos de procesamiento de texto.
Obtención de un objeto WordprocessingDocument
El código comienza con la apertura de un archivo de paquete pasando un nombre de archivo a uno de los métodos Open() sobrecargados (método .NET Shared de Visual Basic o método estático de C#) de la clase WordprocessingDocument que toma una cadena y un valor booleano que especifica si el archivo debe abrirse en modo de lectura y escritura o no. En este caso, el valor booleano es false, lo que especifica que el archivo debe abrirse en modo de solo lectura para evitar cambios accidentales.
// Open a Wordprocessing document for editing.
using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, false))
{
// Insert other code here.
}
La instrucción using proporciona una alternativa recomendada a la típica secuencia .Create, .Save, .Close. Garantiza que se llamará automáticamente al método Dispose (un método interno que Open XML SDK usa para limpiar recursos) cuando se llegue a la llave de cierre. El bloque que sigue a la instrucción using establece un ámbito para el objeto que se crea o se nombra en la instrucción using, en este caso wordDoc. Dado que la clase WordprocessingDocument en Open XML SDK guarda y cierra el objeto automáticamente como parte de su implementación System.IDisposable y que se llama automáticamente a Dispose cuando sale del bloque, no necesita llamar explícitamente a Save y Close, siempre que use using.
Estructura de un documento WordProcessingML
La estructura de documento básica de un documento WordProcessingML contiene los elementos document y body, seguidos de uno o varios elementos a nivel de bloque, como p, que representa un párrafo. Un párrafo contiene uno o varios elementos r. La r representa a run (segmento), que es una región de texto con un conjunto de propiedades comunes, como el formato. Un segmento contiene uno o varios elementos t. El elemento t contiene un intervalo de texto. En el siguiente ejemplo de código se muestra el marcado WordprocessingML de un documento que contiene el texto "Example text".
<w:document xmlns:w="https://schemas.openxmlformats.org/wordprocessingml/2006/main">
<w:body>
<w:p>
<w:r>
<w:t>Example text.</w:t>
</w:r>
</w:p>
</w:body>
</w:document>
Con el SDK de Open XML, puede crear contenido y estructura de documentos mediante clases fuertemente tipadas que corresponden a elementos WordprocessingML . Puede encontrar estas clases en el espacio de nombres DocumentFormat.OpenXml.Wordprocessing . La tabla siguiente muestra los nombres de las clases que corresponden a los elementos document, body, p, r y t.
| Elemento de WordprocessingML | Open XML SDK (clase) | Descripción |
|---|---|---|
| documento | Document | El elemento raíz del elemento de documento principal. |
| body | Body | El contenedor de las estructuras a nivel de bloque, como párrafos, tablas, anotaciones y otras recogidas en la especificación ISO/IEC 29500. |
| p | Paragraph | Un párrafo. |
| r | Run | Un segmento. |
| t | Text | Un intervalo de texto. |
Para obtener más información sobre la estructura general de los elementos y elementos de un documento WordprocessingML, vea Estructura de un documento WordprocessingML.
Elemento Comments
En este procedimiento, se va a trabajar con comentarios. Por lo tanto, resulta útil familiarizarse con la estructura del < elemento comments>. La siguiente información de la especificación ISO/IEC 29500 puede ser útil cuando se trabaja con este elemento.
Este elemento especifica todos los comentarios definidos en el documento actual. Es el elemento raíz de la parte de comentarios de un documento WordprocessingML. Tenga en cuenta el siguiente fragmento de WordprocessingML para el contenido de una parte de comentarios en un documento WordprocessingML:
<w:comments>
<w:comment … >
…
</w:comment>
</w:comments>
El elemento comments contiene el único comentario especificado por este documento en este ejemplo.
© ISO/IEC29500: 2008.
El siguiente fragmento de esquema XML define el contenido de este elemento.
<complexType name="CT_Comments">
<sequence>
<element name="comment" type="CT_Comment" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
Funcionamiento del código de ejemplo
Después de abrir el archivo de origen para su lectura, se crea un objeto mainPart mediante la creación de una instancia de MainDocumentPart. A continuación, se puede crear una referencia a la parte WordprocessingCommentsPart del documento.
// To get the contents of a document part.
public static string GetCommentsFromDocument(string document)
{
string comments = null;
using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, true))
{
MainDocumentPart mainPart = wordDoc.MainDocumentPart;
WordprocessingCommentsPart WordprocessingCommentsPart = mainPart.WordprocessingCommentsPart;
Se puede usar un objeto StreamReader para leer el contenido de la parte WordprocessingCommentsPart del documento y devolver su contenido.
using (StreamReader streamReader = new StreamReader(WordprocessingCommentsPart.GetStream()))
{
comments = streamReader.ReadToEnd();
}
}
return comments;
Código de ejemplo
En el siguiente código se recupera el contenido de una parte WordprocessingCommentsPart incluida en un paquete de documentos WordProcessing. Puede llamar al método GetCommentsFromDocument para ejecutar el programa, tal como se muestra en el siguiente ejemplo.
string document = @"C:\Users\Public\Documents\MyPkg5.docx";
GetCommentsFromDocument(document);
A continuación se muestra el ejemplo de código completo en C# y Visual Basic.
using DocumentFormat.OpenXml.Packaging;
using System;
using System.IO;
GetCommentsFromDocument(args[0]);
// To get the contents of a document part.
static string GetCommentsFromDocument(string document)
{
string? comments = null;
using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, false))
{
if (wordDoc is null)
{
throw new ArgumentNullException(nameof(wordDoc));
}
MainDocumentPart mainPart = wordDoc.MainDocumentPart ?? wordDoc.AddMainDocumentPart();
WordprocessingCommentsPart WordprocessingCommentsPart = mainPart.WordprocessingCommentsPart ?? mainPart.AddNewPart<WordprocessingCommentsPart>();
using (StreamReader streamReader = new StreamReader(WordprocessingCommentsPart.GetStream()))
{
comments = streamReader.ReadToEnd();
}
}
return comments;
}