Agregar un nuevo elemento de documento a un paquete

En este tema se muestra cómo usar las clases del SDK de Open XML para Office para agregar un elemento de documento (archivo) a un documento de procesamiento de texto 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 de DocumentFormat.OpenXml.Packaging.WordprocessingDocument que toma una cadena y un valor booleano que especifica si el archivo se debe abrir para la edición o para el acceso de solo lectura. En este caso, el valor booleano es true, lo que indica que el archivo debe abrirse en modo de lectura y escritura.

C#

    using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, true))
    {
        // Insert other code here.
    }

Visual Basic

    Using wordDoc As WordprocessingDocument = WordprocessingDocument.Open(document, True)
        ' Insert other code here.
    End Using

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 del SDK de Open XML guarda y cierra automáticamente el objeto como parte de su implementación System.IDisposable y porque se llama automáticamente al método Dispose al salir del bloque; no es necesario llamar explícitamente a Save y Close, siempre y cuando use.

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.

Funcionamiento del código de ejemplo

Después de abrir el documento para su edición, en la instrucción using, como objeto WordprocessingDocument, el código crea una referencia a la parte MainDocumentPart y agrega una parte de nuevo XML personalizado. A continuación, lee el contenido del archivo externo que contiene el XML personalizado y lo escribe en la parte CustomXmlPart.

Nota:

[!NOTA] Para usar el nuevo elemento de documento en el documento, agregue un vínculo al elemento de documento en el elemento de relación del nuevo elemento.

C#

    MainDocumentPart mainPart = wordDoc.MainDocumentPart;
    CustomXmlPart myXmlPart = mainPart.AddCustomXmlPart(CustomXmlPartType.CustomXml);

    using (FileStream stream = new FileStream(fileName, FileMode.Open))
    {
        myXmlPart.FeedData(stream);
    }

Visual Basic

    Dim mainPart As MainDocumentPart = wordDoc.MainDocumentPart

    Dim myXmlPart As CustomXmlPart = mainPart.AddCustomXmlPart(CustomXmlPartType.CustomXml)

    Using stream As New FileStream(fileName, FileMode.Open)
        myXmlPart.FeedData(stream)
    End Using

Código de ejemplo

El siguiente código agrega una nueva parte de documento que contiene XML personalizado desde un archivo externo y, a continuación, rellena la parte. Para llamar al método AddCustomXmlPart en el programa, use el ejemplo siguiente que modifica el archivo "myPkg2.docx" agregando un nuevo elemento de documento.

C#

    string document = @"C:\Users\Public\Documents\myPkg2.docx";
    string fileName = @"C:\Users\Public\Documents\myXML.xml";
    AddNewPart(document, fileName);

Visual Basic

    Dim document As String = "C:\Users\Public\Documents\myPkg2.docx"
    Dim fileName As String = "C:\Users\Public\Documents\myXML.xml"
    AddNewPart(document, fileName)

Nota:

[!NOTA] Antes de ejecutar el programa, cambie la extensión de archivo de Word de .docx a .zip y vea el contenido del archivo .zip. A continuación, vuelva a cambiar la extensión a .docx y ejecute el programa. Una vez ejecutado el programa, vuelva a cambiar la extensión a .zip y vea su contenido. Verá una carpeta adicional denominada "customXML". Esta carpeta contiene el archivo XML que representa el elemento agregado.

A continuación se muestra el ejemplo de código completo en C# y Visual Basic.

C#

using DocumentFormat.OpenXml.Packaging;
using System.IO;

AddNewPart(args[0], args[1]);

// To add a new document part to a package.
static void AddNewPart(string document, string fileName)
{
    using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, true))
    {
        MainDocumentPart mainPart = wordDoc.MainDocumentPart ?? wordDoc.AddMainDocumentPart();

        CustomXmlPart myXmlPart = mainPart.AddCustomXmlPart(CustomXmlPartType.CustomXml);

        using (FileStream stream = new FileStream(fileName, FileMode.Open))
        {
            myXmlPart.FeedData(stream);
        }
    }
}

Visual Basic

Imports System.IO
Imports DocumentFormat.OpenXml.Packaging


Module MyModule

    Sub Main(args As String())
    End Sub

    ' To add a new document part to a package.
    Public Sub AddNewPart(ByVal document As String, ByVal fileName As String)
        Using wordDoc As WordprocessingDocument = WordprocessingDocument.Open(document, True)
            Dim mainPart As MainDocumentPart = wordDoc.MainDocumentPart

            Dim myXmlPart As CustomXmlPart = mainPart.AddCustomXmlPart(CustomXmlPartType.CustomXml)

            Using stream As New FileStream(fileName, FileMode.Open)
                myXmlPart.FeedData(stream)
            End Using
        End Using
    End Sub
End Module

Consulte también

• Referencia de la biblioteca de clases del SDK de Open XML