在处理大量定制化文档时，如合同、报告或个人信件，Word 文档中的变量功能变得至关重要。变量允许你存储重用信息，如日期、名字或产品细节，使文档更具个性化和动态性。本文将详细介绍如何使用 Spire.Doc for Python 插入、计数、检索和删除 Word 文档变量，从而提升文档管理的效率和灵活性。
安装 Spire.Doc for Python
本教程需要 Spire.Doc for Python 和 plum-dispatch v1.7.4。您可以通过以下 pip 命令将它们轻松安装到 Windows 中。
如果您不确定如何安装，请参考此教程： 如何在 Windows 中安装 Spire.Doc for Python
Python 插入变量到 Word 文档
Word 变量的工作原理是基于“域”的概念，在Word文档中插入一个变量时，实际上是在插入一个域，这个域指向了存储在文档属性或外部数据源中的某个值。更新域时，Word 会重新计算这些域，显示最新的信息。
Spire.Doc for Python 提供 VariableCollection.Add(name, value) 方法插入变量到 Word，以下是详细步骤：
- 创建 Document 类的对象。
- 调用 Document.AddSection() 方法创建一个新的章节。
- 调用 Section.AddParagraph() 方法在章节中创建一个新的段落。
- 调用 Paragraph.AppendField(fieldName, fieldType) 方法在段落中添加一个变量域（FieldDocVariable），
- 调用 Document.VariableCollection.Add(name, value) 方法在文档的变量集合中添加一个名为“公司名称”的变量，并为其赋值“冰蓝科技”。
- 设置 Document.IsUpdateFields 为 True 更新域。
- 调用 Document.SaveToFile() 方法保存结果文档。
from spire.doc import *
# 创建一个Document对象
document = Document()
# 添加一个新的章节
section = document.AddSection()
# 在章节中添加一个新的段落
paragraph = section.AddParagraph()
# 向段落中添加一个域，类型为FieldDocVariable
paragraph.AppendField("公司名称", FieldType.FieldDocVariable)
# 向文档变量集合中添加一个变量，键为"公司名称"，值为"冰蓝科技"
document.Variables.Add("公司名称", "冰蓝科技")
# 更新域
document.IsUpdateFields = True
# 将文档保存到指定路径
document.SaveToFile("添加变量.docx", FileFormat.Docx2016)
# 释放资源
document.Dispose()
Python 计算 Word 文档的变量个数
使用 Document.Variables.Count 属性获取变量个数，下面是详细步骤：
- 创建 Document 类的对象。
- 调用 Document.LoadFromFile() 加载 Word 文档。
- 调用 Document.Variables.Count 属性获取变量个数。
- 输出到控制台。
from spire.doc import *
# 创建一个Document对象
document = Document()
# 加载Word文档
document.LoadFromFile("添加变量.docx")
# 获取变量个数
count=document.Variables.Count
print(f"变量个数：{count}")
Python 检索 Word 文档的变量
Spire.Doc for Python 提供 GetNameByIndex(int index) 和 GetValueByIndex(int index) 根据索引获取变量名和变量值。下面是详细步骤：
- 创建 Document 类的对象。
- 调用 Document.LoadFromFile() 加载 Word 文档。
- 调用 Document.Variables.GetNameByIndex(index) 方法获取变量名。
- 调用 Document.Variables.GetValueByIndex(index) 方法获取变量值。
- 也可以使用 Document.Variables.get_Item(name) 根据变量名获取其值。
- 输出到控制台。
from spire.doc import *
# 创建一个Document对象
document = Document()
# 加载Word文档
document.LoadFromFile("添加变量.docx")
# 根据索引0获取变量名
name=document.Variables.GetNameByIndex(0)
# 根据索引0获取变量值
value=document.Variables.GetValueByIndex(0)
# 也可以直接通过变量名获取其值，这里获取"公司名称"对应的值
value1=document.Variables.get_Item("公司名称")
# 输出到控制台
print("变量名:", name)
print("变量值:", value)
Python 删除 Word 文档的变量
VariableCollection.Remove(name) 方法可以删除文档中的指定变量，参数为该变量的名称。
- 创建 Document 类的对象。
- 调用 Document.LoadFromFile() 加载 Word 文档。
- 调用 Document.Variables.Remove(name) 方法移除变量。
- 设置 Document.IsUpdateFields 为 True 更新域。
- 调用 Document.SaveToFile() 方法保存结果文档。
from spire.doc import *
# 创建一个Document对象
document = Document()
# 加载Word文档
document.LoadFromFile("添加变量.docx")
# 移除名称为“公司名称”的变量
document.Variables.Remove("公司名称")
# 更新域
document.IsUpdateFields = True
# 保存文档
document.SaveToFile("移除变量.docx",FileFormat.Docx2016)
申请临时 License
如果您希望删除结果文档中的评估消息，或者摆脱功能限制，请该Email地址已收到反垃圾邮件插件保护。要显示它您需要在浏览器中启用JavaScript。获取有效期 30 天的临时许可证。
