Cómo: Agregar elementos XML personalizados a documentos mediante complementos de nivel de aplicación

Artículo
02/19/2013

Puede almacenar datos XML en los siguientes tipos de documento creando un elemento XML personalizado en un complemento de nivel de aplicación:

Un libro de Microsoft Office Excel.
Un documento de Microsoft Office Word.
Una presentación de Microsoft Office PowerPoint.

Para obtener más información, vea Información general sobre los elementos XML personalizados.

La información deSe aplica a: The en este tema se aplica a los proyectos de nivel de aplicación las siguientes aplicaciones: Excel 2010; PowerPoint 2010; Word 2010.Para obtener más información, vea Características disponibles por aplicación y tipo de proyecto de Office.

Para agregar un elemento XML personalizado a un libro de Excel

Agregue un objeto CustomXMLPart nuevo a la colección CustomXMLParts del libro.CustomXMLPart contiene la cadena XML que desea almacenar en el libro.

En el ejemplo de código siguiente se agrega un elemento XML personalizado al libro especificado.

Private Sub AddCustomXmlPartToWorkbook(ByVal workbook As Excel.Workbook)
    Dim xmlString As String = _
        "<?xml version=""1.0"" encoding=""utf-8"" ?>" & _
            "<employees https://schemas.microsoft.com/vsto/samples"">" & _
                "<employee>" & _
                    "<name>Karina Leal</name>" & _
                    "<hireDate>1999-04-01</hireDate>" & _
                    "<title>Manager</title>" & _
                "</employee>" & _
            "</employees>"

    Dim employeeXMLPart As Office.CustomXMLPart = _
        workbook.CustomXMLParts.Add(xmlString)
End Sub

private void AddCustomXmlPartToWorkbook(Excel.Workbook workbook)
{
    string xmlString =
        "<?xml version=\"1.0\" encoding=\"utf-8\" ?>" +
        "<employees xmlns=\"https://schemas.microsoft.com/vsto/samples\">" +
            "<employee>" +
                "<name>Karina Leal</name>" +
                "<hireDate>1999-04-01</hireDate>" +
                "<title>Manager</title>" +
            "</employee>" +
        "</employees>";

    Office.CustomXMLPart employeeXMLPart = workbook.CustomXMLParts.Add(xmlString, missing);
}

Agregue el método AddCustomXmlPartToWorkbook a la clase ThisAddIn en un proyecto de nivel de aplicación para Excel.
Llame al método desde otro fragmento de código del proyecto.Por ejemplo, para que se cree el elemento XML personalizado cuando el usuario abra un libro, llame al método desde el controlador de eventos para el evento WorkbookOpen.

Para agregar un elemento XML personalizado a un documento de Word

Agregue un objeto CustomXMLPart nuevo a la colección CustomXMLParts del documento.CustomXMLPart contiene la cadena XML que desea almacenar en el documento.

En el ejemplo de código siguiente se agrega un elemento XML personalizado al documento especificado.

Private Sub AddCustomXmlPartToActiveDocument(ByVal document As Word.Document)
    Dim xmlString As String = _
        "<?xml version=""1.0"" encoding=""utf-8"" ?>" & _
            "<employees https://schemas.microsoft.com/vsto/samples"">" & _
                "<employee>" & _
                    "<name>Karina Leal</name>" & _
                    "<hireDate>1999-04-01</hireDate>" & _
                    "<title>Manager</title>" & _
                "</employee>" & _
            "</employees>"

    Dim employeeXMLPart As Office.CustomXMLPart = _
        document.CustomXMLParts.Add(xmlString)
End Sub

private void AddCustomXmlPartToActiveDocument(Word.Document document)
{
    string xmlString =
        "<?xml version=\"1.0\" encoding=\"utf-8\" ?>" +
        "<employees xmlns=\"https://schemas.microsoft.com/vsto/samples\">" +
            "<employee>" +
                "<name>Karina Leal</name>" +
                "<hireDate>1999-04-01</hireDate>" +
                "<title>Manager</title>" +
            "</employee>" +
        "</employees>";

    Office.CustomXMLPart employeeXMLPart = document.CustomXMLParts.Add(xmlString, missing);
}

Agregue el método AddCustomXmlPartToDocument a la clase ThisAddIn en un proyecto de nivel de aplicación para Word.
Llame al método desde otro fragmento de código del proyecto.Por ejemplo, para que se cree el elemento XML personalizado cuando el usuario abra un documento, llame al método desde el controlador de eventos para el evento DocumentOpen.

Para agregar un elemento XML personalizado a una presentación de PowerPoint

Agregue un objeto CustomXMLPart nuevo a la colección CustomXMLParts de la presentación.CustomXMLPart contiene la cadena XML que desea almacenar en la presentación.

En el ejemplo de código siguiente se agrega un elemento XML personalizado a la presentación especificada.

Private Sub AddCustomXmlPartToPresentation(ByVal presentation As PowerPoint.Presentation)
    Dim xmlString As String = _
        "<?xml version=""1.0"" encoding=""utf-8"" ?>" & _
            "<employees https://schemas.microsoft.com/vsto/samples"">" & _
                "<employee>" & _
                    "<name>Karina Leal</name>" & _
                    "<hireDate>1999-04-01</hireDate>" & _
                    "<title>Manager</title>" & _
                "</employee>" & _
            "</employees>"
    Dim employeeXMLPart As Office.CustomXMLPart = _
        presentation.CustomXMLParts.Add(xmlString)
End Sub

private void AddCustomXmlPartToPresentation(PowerPoint.Presentation presentation)
{
    string xmlString =
        "<?xml version=\"1.0\" encoding=\"utf-8\" ?>" +
        "<employees xmlns=\"https://schemas.microsoft.com/vsto/samples\">" +
            "<employee>" +
                "<name>Karina Leal</name>" +
                "<hireDate>1999-04-01</hireDate>" +
                "<title>Manager</title>" +
            "</employee>" +
        "</employees>";

    Office.CustomXMLPart employeeXMLPart = 
        presentation.CustomXMLParts.Add(xmlString, missing);
}

Agregue el método AddCustomXmlPartToPresentation a la clase ThisAddIn en un proyecto de nivel de aplicación para PowerPoint.
Llame al método desde otro fragmento de código del proyecto.Por ejemplo, para que se cree el elemento XML personalizado cuando el usuario abra una presentación, llame al método desde el controlador de eventos para el evento AfterPresentationOpen.

Programación eficaz

Por simplificar, en este ejemplo se utiliza una cadena XML que se define como una variable local del método.Normalmente, debe obtener el XML de un origen externo, por ejemplo, un archivo o una base de datos.

Vea también

Tareas

Cómo: Agregar elementos XML personalizados a personalizaciones de nivel de documento

Conceptos

Información general sobre los elementos XML personalizados

Compartir a través de