Word 文档中的 目录 (TOC) 可让您大致了解文档包含的内容。此外，它还允许您导航到文档的特定部分。在本文中，您将学习如何以编程方式处理 Word 文档中的目录。特别是，本文介绍了如何在 C# 中添加、提取、更新或删除 Word 文档中的目录。
在 Word 文档中添加、编辑或删除 TOC 的 C# API
为了使用 Word 文档中的目录，我们将使用 Aspose.Words for .NET。所述 API 旨在从 .NET 应用程序中执行基本和高级 Word 自动化功能。此外，它使您可以很好地控制 Word 文档中目录的操作。您可以 下载 API 或使用 NuGet 安装它。
PM> Install-Package Aspose.Words
在 C# 中的 Word 文档中添加目录
以下是使用 Aspose.Words for .NET 将目录添加到 Word 文档的步骤。
- 创建 Document 类的实例（在加载现有 Word 文档的情况下，在构造函数中提供文件的路径）。
- 创建一个 DocumentBuilder 类的实例，并使用之前创建的 Document 对象对其进行初始化。
- 使用 DocumentBuilder.InsertTableOfContents("\\o \"1-3\\" \\h \\z \\u") 方法插入目录。
- 使用 Document.UpdateFields() 方法更新字段。
- 使用 Document.Save(String) 方法保存 Word 文档。
以下代码示例演示如何在 C# 中的 Word 文档中添加目录。
// 如需完整的示例和数据文件，请访问 https://github.com/aspose-words/Aspose.Words-for-.NET
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_WorkingWithDocument();
// 初始化文档。
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// 在文档开头插入目录。
builder.InsertTableOfContents("\\o \"1-3\" \\h \\z \\u");
// 新插入的目录最初是空的。
// 它需要通过更新文档中的字段来填充。
doc.UpdateFields();
dataDir = dataDir + "DocumentBuilderInsertTOC_out.doc";
doc.Save(dataDir);
C# 从 Word 文档中提取目录
以下是从 Word 文档的目录中提取字段的步骤。
- 使用 Document 类加载 Word 文档。
- 使用 Document.Range.Fields 集合循环遍历文档中的每个 Field。
- 使用 Field.Type 属性检查字段类型是否为超链接。
- 检查该字段是否位于目录部分的表下。
- 检索字段信息并打印。
以下代码示例演示如何使用 C# 从 Word 文档中提取目录。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_WorkingWithDocument();
string fileName = "TOC.doc";
Aspose.Words.Document doc = new Aspose.Words.Document(dataDir + fileName);
foreach (Field field in doc.Range.Fields)
{
if (field.Type.Equals(Aspose.Words.Fields.FieldType.FieldHyperlink))
{
FieldHyperlink hyperlink = (FieldHyperlink)field;
if (hyperlink.SubAddress != null && hyperlink.SubAddress.StartsWith("_Toc"))
{
Paragraph tocItem = (Paragraph)field.Start.GetAncestor(NodeType.Paragraph);
Console.WriteLine(tocItem.ToString(SaveFormat.Text).Trim());
Console.WriteLine("------------------");
if (tocItem != null)
{
Bookmark bm = doc.Range.Bookmarks[hyperlink.SubAddress];
// 获取此 TOC 项指向的位置
Paragraph pointer = (Paragraph)bm.BookmarkStart.GetAncestor(NodeType.Paragraph);
Console.WriteLine(pointer.ToString(SaveFormat.Text));
}
} // End If
}// End If
}// End Foreach
在 C# 中更新 Word 文档中的目录
每当您将某些内容附加到 Word 文档时，都需要更新目录。为了以编程方式执行此操作，您只需在保存文档之前调用 Document.UpdateFields() 方法。
在 C# 中删除 Word 文档中的目录
Aspose.Words for .NET 还允许您从 Word 文档中删除目录。以下是执行此操作的步骤。
- 首先，使用 Document 类加载 Word 文档。
- 获取每个 TOC 的 FieldStart 节点并将其存储在一个数组中。
- 遍历节点，直到获得类型为 FieldEnd 的节点（TOC 的结尾）。
- 使用 Node.Remove() 方法删除节点并保存更新的文档。
以下代码示例演示如何从 C# 中的 Word 文档中删除目录。
// 如需完整的示例和数据文件，请访问 https://github.com/aspose-words/Aspose.Words-for-.NET
public static void Run()
{
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_WorkingWithStyles();
// 打开包含目录的文档。
Document doc = new Document(dataDir + "Document.TableOfContents.doc");
// 从文档中删除第一个目录。
RemoveTableOfContents(doc, 0);
dataDir = dataDir + "Document.TableOfContentsRemoveToc_out.doc";
// 保存输出。
doc.Save(dataDir);
Console.WriteLine("\nSpecified TOC from a document removed successfully.\nFile saved at " + dataDir);
}
///<summary>
/// 从文档中删除指定的目录字段。
///</summary>
///<param name="doc">要从中删除字段的文档。</param>
///<param name="index">要删除的 TOC 的从零开始的索引。</param>
public static void RemoveTableOfContents(Document doc, int index)
{
// 将 TOC 字段的 FieldStart 节点存储在文档中以便快速访问。
ArrayList fieldStarts = new ArrayList();
// 这是一个列表，用于存储在指定 TOC 中找到的节点。他们将被删除
// 在这个方法结束时。
ArrayList nodeList = new ArrayList();
foreach (FieldStart start in doc.GetChildNodes(NodeType.FieldStart, true))
{
if (start.FieldType == FieldType.FieldTOC)
{
// 添加所有 FieldTOC 类型的 FieldStart。
fieldStarts.Add(start);
}
}
// 确保传递的索引指定的 TOC 存在。
if (index > fieldStarts.Count - 1)
throw new ArgumentOutOfRangeException("TOC index is out of range");
bool isRemoving = true;
// 获取指定 TOC 的 FieldStart。
Node currentNode = (Node)fieldStarts[index];
while (isRemoving)
{
// 存储这些节点并稍后将它们全部删除会更安全。
nodeList.Add(currentNode);
currentNode = currentNode.NextPreOrder(doc);
// 一旦我们遇到 FieldTOC 类型的 FieldEnd 节点，我们就知道我们在最后
// 当前的TOC，我们可以到此为止。
if (currentNode.NodeType == NodeType.FieldEnd)
{
FieldEnd fieldEnd = (FieldEnd)currentNode;
if (fieldEnd.FieldType == FieldType.FieldTOC)
isRemoving = false;
}
}
// 删除在指定 TOC 中找到的所有节点。
foreach (Node node in nodeList)
{
node.Remove();
}
}
获取免费 API 许可证
如果您想在没有评估限制的情况下试用 API，您可以获得免费的临时许可证。
结论
在本文中，您学习了如何以编程方式处理 Word 文档中的目录。分步指南和代码示例展示了如何在 C# 中从 Word 文档中添加、更新、提取和删除目录。您可以使用 documentation 探索有关 C# Word 自动化 API 的更多信息。如果您有任何问题或疑虑，请通过我们的 论坛 与我们联系。