本演练演示如何从文档中的 Visual Basic for Applications (VBA) 代码调用 Microsoft Office Word 的文档级自定义方法。 该过程涉及三个基本步骤:将方法添加到 ThisDocument 主机项类,向 VBA 代码公开该方法,然后从文档中的 VBA 代码调用该方法。
适用于: 本主题中的信息适用于 Excel 和 Word 的文档级项目。 有关详细信息,请参阅 Office 应用程序和项目类型提供的功能。
尽管本演练专门使用 Word,但本演练演示的概念也适用于 Excel 的文档级项目。
本演练阐释了以下任务:
创建包含 VBA 代码的文档。
使用 Word 中的信任中心来信任文档的位置。
将方法添加到
ThisDocument宿主项类。向 VBA 代码公开该方法。
从 VBA 代码调用方法。
注释
以下说明中的某些 Visual Studio 用户界面元素在计算机上出现的名称或位置可能会不同。 这些元素取决于你所使用的 Visual Studio 版本和你所使用的设置。 有关详细信息,请参阅个性化设置 Visual Studio IDE。
先决条件
你需要满足以下条件才能完成本演练:
包含 Microsoft Office 开发人员工具的 Visual Studio 版本。 有关详细信息,请参阅 配置计算机以开发 Office 解决方案。
Microsoft Word
创建包含 VBA 代码的文档
第一步是创建一个启用了宏的文档,其中包含一个简单的 VBA 宏。 在创建基于该文档的 Visual Studio 项目之前,文档必须包含 VBA 项目。 否则,Visual Studio 无法修改 VBA 项目,使 VBA 代码能够调用自定义程序集。
如果已有包含要使用的 VBA 代码的文档,则可以跳过此步骤。
创建包含 VBA 代码的文档
启动 Word。
将活动文档另存为 Word Macro-Enabled 文档(*.docm), 名称为 DocumentWithVBA。 将其保存在方便的位置,例如桌面。
在功能区上,单击“ 开发人员 ”选项卡。
注释
如果 “开发人员 ”选项卡不可见,必须先显示它。 有关详细信息,请参阅 “如何:在功能区上显示开发人员”选项卡。
在 “代码 ”组中,单击 “Visual Basic”。
此时会打开 Visual Basic 编辑器。
在 “项目” 窗口中,双击 ThisDocument。
此时会打开对象的
ThisDocument代码文件。将以下 VBA 代码添加到代码文件。 此代码定义一个不执行任何作的简单函数。 此函数的唯一用途是确保文档中存在 VBA 项目。 这对于本演练的后续步骤是必需的。
Sub EmptySub() End Sub保存文档并退出 Word。
创建项目
现在,可以为 Word 创建一个文档级项目,该项目使用之前创建的启用了宏的文档。
创建新项目
启动 Visual Studio。
在“ 文件 ”菜单上,指向“ 新建”,然后单击“ 项目”。 如果 IDE 设置为使用 Visual Basic 开发设置,请在 “文件 ”菜单上单击“ 新建项目”。
在模板窗格中,展开 Visual Basic,然后展开 Office/SharePoint。
选择 Office 加载项 节点。
在项目模板列表中,选择 Word 2010 文档 或 Word 2013 文档 项目。
在 “名称 ”框中,键入 CallingCodeFromVBA。
单击 “确定” 。
此时会打开 Visual Studio Tools for Office 项目向导 。
选择 “复制现有文档”,然后在 现有文档框的完整路径 中指定之前创建的 DocumentWithVBA 文档的位置。 如果使用自己的启用了宏的文档,请改为指定此文档的位置。
单击“完成”。
Visual Studio 在设计器中打开 DocumentWithVBA 文档,并将 CallingCodeFromVBA 项目添加到 解决方案资源管理器。
信任文档的位置
在解决方案中向文档中的 VBA 代码公开代码之前,必须信任文档中的 VBA 才能运行。 有多种方法可以实现这一点。 在 Word 的信任中心信任该文档的位置。
信任文档的位置
启动 Word。
单击“ 文件 ”选项卡。
单击 “Word 选项” 按钮。
在“类别”窗格中,单击“ 信任中心”。
在详细信息窗格中,单击“ 信任中心设置”。
在“类别”窗格中,单击“ 受信任的位置”。
在详细信息窗格中,单击“ 添加新位置”。
在 “Microsoft Office 受信任位置 ”对话框中,浏览到包含 CallingCodeFromVBA 项目的文件夹。
选择也信任此位置的子文件夹。
在 “Microsoft Office 受信任位置 ”对话框中,单击“ 确定”。
在 “信任中心 ”对话框中,单击“ 确定”。
在 “Word 选项 ”对话框中,单击“ 确定”。
退出 Word。
向 ThisDocument 类添加方法
设置 VBA 项目后,请将方法添加到可从 VBA 代码调用的 ThisDocument 主机项类。
向 ThisDocument 类添加方法
在 解决方案资源管理器中,右键单击 ThisDocument.vb,然后单击“ 查看代码”。
ThisDocument.vb文件将在代码编辑器中打开。
将以下方法添加到
ThisDocument类。 此方法在文档开头创建包含两行和两列的表。 参数指定在第一行中显示的文本。 在本演练的后面部分,你将从文档中的 VBA 代码调用此方法。Public Sub CreateTable(ByVal firstColumnHeader As String, _ ByVal secondColumnHeader As String) Me.Paragraphs(1).Range.InsertParagraphBefore() Dim table1 As Word.Table = Me.Tables.Add(Me.Paragraphs(1).Range, 2, 2) With table1 .Style = "Table Professional" .Cell(1, 1).Range.Text = firstColumnHeader .Cell(1, 2).Range.Text = secondColumnHeader End With End Sub构建项目。
向 VBA 代码公开方法
若要向CreateTable文档中的 VBA 代码公开该方法,请将主机项的 ThisDocument 属性设置为 True。
将方法暴露给 VBA 代码
在 解决方案资源管理器中,双击 ThisDocument.vb。
DocumentWithVBA 文件将在设计器中打开。
在 “属性” 窗口中,选择 EnableVbaCallers 属性,并将值更改为 True。
在显示的消息中单击 “确定 ”。
构建项目。
从 VBA 代码调用方法
现在可以从文档中的 VBA 代码调用 CreateTable 该方法。
注释
在本演练中,将在调试项目时向文档添加 VBA 代码。 每次生成项目时,您添加到此文档的 VBA 代码都会被覆盖,因为 Visual Studio 会用主项目文件夹中的文档副本替换生成输出文件夹中的文档。 如果要保存 VBA 代码,可以将它复制到项目文件夹中的文档。 有关详细信息,请参阅 合并 VBA 和文档级自定义。
从 VBA 代码调用方法
按 F5 运行项目。
在 “开发人员 ”选项卡上的 “代码 ”组中,单击 “Visual Basic”。
此时会打开 Visual Basic 编辑器。
在 “插入 ”菜单上,单击“ 模块”。
将以下代码添加到新模块。
此代码调用
CreateTable自定义程序集中的方法。 宏使用CallVSTOAssembly对象的属性ThisDocument访问此方法。 在本演练的前面步骤中设置 EnableVbaCallers 属性时,自动生成此属性。Sub CreateTable() Call ThisDocument.CallVSTOAssembly.CreateTable("Employee Name", "Start Date") End Sub按 F5。
验证是否已将新表添加到文档中。
无需保存更改即可退出 Word。
后续步骤
可以在以下主题中了解有关从 VBA 调用 Office 解决方案中的代码的详细信息:
从 VBA 调用 Visual C# 自定义中的代码。 此过程与 Visual Basic 进程不同。 有关详细信息,请参阅 演练:在 Visual C# 项目中从 VBA 调用代码。
从 VBA 调用 VSTO 外接程序中的代码。 有关详细信息,请参阅 演练:从 VBA 调用 VSTO 外接程序中的代码。