Python批量处理Word文档：添加和删除批注

阳光穿透心脏的1/2处 2024-02-20 10:48 74阅读 0赞

批注可以在不影响文档内容的情况下对内容做出评论、解释或探讨，是Word文档协作编辑的常用功能。在Word文档中，用户可以对指定内容添加批注，批注内容将显示在文档右边区域，不会遮挡文档内容，同时被批注区域将强调显示。而批注的内容处理完毕后，其他用户可对该批注进行回复或删除批注，从而实现创作者之间的交流。本文将介绍如何通过Python程序处理**Word文档批注**，实现**添加、回复、编辑及删除批注**的批量操作。

### 文章目录  @\[TOC\]  添加批注到文档内容  回复文档批注  删除文档中的批注 ###

使用工具：[Spire.Doc for Python][]，可从链接下载，或通过PyPI安装：

pip install Spire.Doc

### 添加批注到文档内容 ###

1.  创建 **Document** 类对象，并使用 **Document.LoadFromFile()** 方法加载 Word 文档。
2.  使用 **Document.FindString()** 方法查找要批注的文本。
3.  创建批注类对象，通过 **Comment.Body.AddParagraph().Text** 属性设置批注内容，并通过 **Comment.Format.Author** 属性设置批注作者。
4.  使用 **TextSelection.GetAsOneRange()** 方法将文本作为一个文本范围获取，并通过 **TextRange.OwnerParagraph** 属性获取文本所属的段落。
5.  使用 **Paragraph.ChildObjects.Insert()** 方法在找到的文本后插入批注。
6.  创建批注开始标记和结束标记，并通过 **CommentMark.CommentId** 属性将它们设置为创建批注的开始和结束标记。
7.  使用 **Paragraph.ChildObjects.Insert()** 方法将批注开始标记和结束标记分别插入查找到的文本的前后。
8.  使用 **Document.SaveToFile()** 方法保存文档。

**Python**

from spire.doc import *
    from spire.doc.common import *
    
    # 创建一个 Document 类的对象并加载一个 Word 文档
    doc = Document()
    doc.LoadFromFile("示例.docx")
    
    # 查找要添加评论的文本
    text = doc.FindString("色彩空间模型", True, True)
    
    # 创建一个评论并设置评论的内容和作者
    comment = Comment(doc)
    comment.Body.AddParagraph().Text = "还有如Lab、YUV、XYZ等色彩空间模型。"
    comment.Format.Author = "力海"
    
    # 将找到的文本作为文本范围，并获取其所属的段落
    range = text.GetAsOneRange()
    paragraph = range.OwnerParagraph
    
    # 将评论添加到段落中
    paragraph.ChildObjects.Insert(paragraph.ChildObjects.IndexOf(range) + 1, comment)
    
    # 创建评论起始标记和结束标记，并将它们设置为创建的评论的起始标记和结束标记
    commentStart = CommentMark(doc, CommentMarkType.CommentStart)
    commentEnd = CommentMark(doc, CommentMarkType.CommentEnd)
    commentStart.CommentId = comment.Format.CommentId
    commentEnd.CommentId = comment.Format.CommentId
    
    # 在找到的文本之前和之后插入创建的评论起始和结束标记
    paragraph.ChildObjects.Insert(paragraph.ChildObjects.IndexOf(range), commentStart)
    paragraph.ChildObjects.Insert(paragraph.ChildObjects.IndexOf(range) + 1, commentEnd)
    
    # 保存文档
    doc.SaveToFile("output/添加批注.docx")
    doc.Close()

**添加效果**  
![Python添加批注到Word文档文本][Python_Word]

### 回复文档批注 ###

使用 **Comment.ReplyToComment(Comment)** 方法即可将一个批注设置为另一个批注的回复。操作步骤如下：

1.  创建 **Document** 类对象，并使用 **Document.LoadFromFile()** 方法加载 Word 文档。
2.  使用 **Document.Comments.get\_Item()** 方法获取批注。
3.  创建批注，并通过 **Comment.Body.AddParagraph().Text** 属性和 **Comment.Format.Author** 属性设置其内容和作者。
4.  使用 **Comment.ReplyToComment()** 方法将创建的批注设置为对已获取批注的回复。
5.  使用 **Document.SaveToFile()** 方法保存文档。

**Python**

from spire.doc import *
    from spire.doc.common import *
    
    # 创建一个 Document 类对象并加载一个 Word 文档
    doc = Document()
    doc.LoadFromFile("output/添加批注.docx")
    
    # 获取一个注释
    comment = doc.Comments.get_Item(0)
    
    # 创建一个回复注释并设置其内容和作者
    reply = Comment(doc)
    reply.Body.AddParagraph().Text = "将在文中列举更多颜色空间模型。"
    reply.Format.Author = "利文"
    
    # 将创建的注释设置为获取到的注释的回复
    comment.ReplyToComment(reply)
    
    # 保存文档
    doc.SaveToFile("output/回复批注.docx")
    doc.Close()

**回复效果**  
![Python回复Word文档批注][Python_Word 1]

### 删除文档中的批注 ###

可使用 Document.Comments.RemoveAt() 方法根据参数删除指定批注或使用 Document.Clear() 方法删除文档所有批注。操作步骤如下：

1.  创建 **Document** 类对象，并使用 **Document.LoadFromFile()** 方法加载 Word 文档。
2.  使用 **Document.Comments.RemoveAt()** 方法删除特定批注，或使用 **Document.Comments.Clear()** 方法删除所有批注。
3.  使用 **Document.SaveToFile()** 方法保存文档。

**Python**

from spire.doc import *
    from spire.doc.common import *
    
    # 创建一个 Document 类对象并加载一个 Word 文档
    doc = Document()
    doc.LoadFromFile("output/添加批注.docx")
    
    # 移除第二个注释
    doc.Comments.RemoveAt(1)
    
    # 移除所有注释
    #doc.Comments.Clear()
    
    # 保存文档
    doc.SaveToFile("output/删除批注.docx")
    doc.Close()

以上是关于如何在Word文档中添加、回复和删除批注的介绍，更多教程请前往[Spire.Doc for Python教程][Spire.Doc for Python 1]查看。

[Spire.Doc for Python]: https://www.e-iceblue.cn/Introduce/Spire-Doc-Python.html
[Python_Word]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/71a38b7e723b4b88a6d1758126c136cc.png
[Python_Word 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/bec97a8848144a3e8dba98d48926cb7a.png
[Spire.Doc for Python 1]: https://www.e-iceblue.cn/docforpython/spire-doc-for-python-program-guide-content.html