如何:向文档级自定义项中添加自定义 XML 部件

通过在文档级自定义项中创建自定义 XML 部件,您可以将 XML 数据存储在 Microsoft Office Excel 工作簿或 Microsoft Office Word 文档中。有关更多信息,请参见自定义 XML 部件概述

**适用于:**本主题中的信息适用于以下应用程序的文档级项目:Excel 2013 和 Excel 2010;Word 2013 和 Word 2010。有关更多信息,请参见按 Office 应用程序和项目类型提供的功能

说明说明

Visual Studio 没有为 Microsoft Office PowerPoint 提供文档级项目。有关使用应用程序级外接程序向 PowerPoint 演示文稿中添加自定义 XML 部件的信息,请参见如何:使用应用程序级外接程序将自定义 XML 部件添加到文档中

将自定义 XML 部件添加到 Excel 工作簿

  1. 将新的 CustomXMLPart 对象添加到工作簿的 CustomXMLParts 集合中。CustomXMLPart 包含要存储在工作簿中的 XML 字符串。

    Private Sub AddCustomXmlPartToWorkbook()
        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 = Me.CustomXMLParts.Add(xmlString)
    End Sub
    
    private void AddCustomXmlPartToWorkbook()
    {
        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 = this.CustomXMLParts.Add(xmlString, missing);
    }
    
  2. 将 AddCustomXmlPartToWorkbook 方法添加到 Excel 文档级项目的 ThisWorkbook 类中。

  3. 从项目内其他代码中调用该方法。例如,若要在用户打开工作簿时创建自定义 XML 部件,请从 ThisWorkbook_Startup 事件处理程序中调用该方法。

将自定义 XML 部件添加到 Word 文档中

  1. 将新的 CustomXMLPart 对象添加到文档的 CustomXMLParts 集合中。CustomXMLPart 包含要存储在文档中的 XML 字符串。

    Private Sub AddCustomXmlPartToDocument()
        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 = _
            Me.CustomXMLParts.Add(xmlString)
    End Sub
    
    private void AddCustomXmlPartToDocument()
    {
        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 = this.CustomXMLParts.Add(xmlString, missing);
    }
    
  2. 将 AddCustomXmlPartToDocument 方法添加到 Word 文档级项目的 ThisDocument 类中。

  3. 从项目内其他代码中调用该方法。例如,若要在用户打开文档时创建自定义 XML 部件,请从 ThisDocument_Startup 事件处理程序中调用该方法。

可靠编程

为简单起见,此示例使用在该方法中定义为本地变量的 XML 字符串。通常,您应从外部源(比如文件或数据库)获取 XML。

请参见

任务

如何:使用应用程序级外接程序将自定义 XML 部件添加到文档中

概念

自定义 XML 部件概述