将新文档部件添加到包中

项目
01/21/2025

本主题演示如何使用 Open XML SDK for Office 中的类以编程方式将文档部件 (文件) 添加到字处理文档中。

包和文档部件

Open XML 文档存储为包，其格式由 ISO/IEC 29500 定义。包可以具有多个彼此之间存在关系的部件。部件之间的关系控制文档的类别。如果文档的包关系项包含与主文档部件的关系，可将文档定义为字处理文档。如果文档的包关系项包含与演示文稿部件的关系，可将文档定义为演示文稿文档。如果文档的包关系项包含与工作簿部件的关系，可将文档定义为电子表格文档。在本操作方法主题中，您将使用字处理文档包。

获取 WordprocessingDocument 对象

该代码首先打开包文件，方法是将文件名传递给的重载 Open 方法 WordprocessingDocument 之一，该方法采用字符串和布尔值，该值指定是应打开文件进行编辑还是进行只读访问。在这种情况下，布尔值 true 指定应在读/写模式下打开文件。

C#
Visual Basic

using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, true))

Using wordDoc As WordprocessingDocument = WordprocessingDocument.Open(document, True)

在 v3.0.0+ 中， Close() 已删除方法，转而依赖于 using 语句。它确保在 Dispose() 到达右大括号时自动调用方法。 using 语句后面的块为 using 语句中创建或指定的对象设定范围。 WordprocessingDocument由于 Open XML SDK 中的类会自动保存并关闭对象作为其IDisposable实现的一using部分，并且由于Dispose()在退出块时会自动调用，因此无需显式调用 Save() 或 Dispose() ，只要使用语句。

WordProcessingML 文档的结构

文档的基本文档结构WordProcessingML由和 body 元素组成document，后跟一个或多个块级元素（例如 p表示段落）。段落包含一个或多个 r 元素。 r代表 run，它是具有一组通用属性（如格式设置）的文本区域。运行包含一个或多个 t 元素。元素 t 包含文本范围。下面的代码示例演示 WordprocessingML 包含文本“示例文本”的文档的标记。

    <w:document xmlns:w="http://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>

使用 Open XML SDK，可以使用与元素对应的 WordprocessingML 强类型类创建文档结构和内容。可以在命名空间中找到这些类。下表列出了对应于、、body、 rp和 t 元素的类的document类名。

WordprocessingML 元素	Open XML SDK 类	说明
`<document/>`	Document	主文档部件的根元素。
`<body/>`	Body	块级结构（如段落、表格、批注和 ISO/IEC 29500 规范中指定的其他项）的容器。
`<p/>`	Paragraph	段落。
`<r/>`	Run	一段连续文本。
`<t/>`	Text	文本范围。

有关 WordprocessingML 文档的各个部分和元素的整体结构的详细信息，请参阅 WordprocessingML 文档的结构。

示例代码的工作原理

打开文档进行编辑后，在 using 语句中，代码将创建对 WordprocessingDocument 部件的 MainDocumentPart 引用，并添加新的自定义 XML 部件。然后，它会读取包含自定义 XML 的外部文件的内容，并将其写入部件 CustomXmlPart 。

注意

[!注释] 若要使用文档中的新文档部件，请在新部件的关系部件中添加指向该文档部件的链接。

C#
Visual Basic

MainDocumentPart mainPart = wordDoc.MainDocumentPart ?? wordDoc.AddMainDocumentPart();

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

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

Dim mainPart As MainDocumentPart = If(wordDoc.MainDocumentPart, wordDoc.AddMainDocumentPart())

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

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

示例代码

下面的代码添加一个包含外部文件中的自定义 XML 的新文档部件，然后填充该部件。若要在程序中调用 AddCustomXmlPart 方法，请使用以下示例，通过向该文件添加新的文档部件来修改该文件。

C#
Visual Basic

string document = args[0];
string fileName = args[1];

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

Dim document As String = args(0)
Dim fileName As String = args(1)

AddNewPart(document, fileName)

注意

[!注释] 在运行程序之前，将 Word 文件扩展名由 .docx 更改为 .zip，并查看 zip 文件的内容。然后，再将扩展名重新更改为 .docx 并运行程序。运行程序后，再将文件扩展名更改为 .zip 并查看其内容。你将看到名为“customXML”的额外文件夹。此文件夹包含表示所添加部件的 XML 文件

以下是使用 C# 和 Visual Basic 编写的完整示例代码。

C#
Visual Basic

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);
        }
    }
}

Sub AddNewPart(document As String, fileName As String)
    Using wordDoc As WordprocessingDocument = WordprocessingDocument.Open(document, True)
        Dim mainPart As MainDocumentPart = If(wordDoc.MainDocumentPart, wordDoc.AddMainDocumentPart())

        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

另请参阅

Open XML SDK 类库参考

通过