Word模板VBA按钮失效：手动执行正常，点击按钮数组值丢失

问题场景 #

我正在创建一个Word.dotm模板，功能是从表格导入产品信息，用户通过列表和搜索框选择产品后，产品信息会以<<Example>>这类占位符显示在模板里。我用products()数组存储选中产品的名称和价格，期望在文档末尾生成包含产品名称与价格的列表。但绑定了GenerateQuotation_Click的按钮点击后无效果，数组值直接消失；手动按F5执行该Sub却能正常运行，疑似模板按钮与基于模板新建文档的数组存在通信异常。

相关VBA代码 #

Dim products() As Variant

' 添加产品的子过程
Sub determinePrice()

    selectedRegion = ActiveDocument.ComboBox1.Value 
    
    Dim price As Variant

    Select Case selectedRegion
        Case "A"
            preco = dataArray(excelRowIndex, 11) 
        Case "B"
            preco = dataArray(excelRowIndex, 12)
    End Select

    If IsNumeric(preco) Then
        Call RetrieveTotalPreco
        totalPrice = totalPrice + price
        price = Format(price, "Currency")
    End If
    
    Call AddProduct(dataArray(excelRowIndex, 2), price)
    
    replaceText "<<Price>>", CStr(price)
    StoreTotalPrice

End Sub

Sub AddProduct(name As Variant, price As Variant)
    Dim currentSize As Long
    Dim tempMatrix() As Variant
    Dim i As Long
    
    On Error Resume Next
    currentSize = UBound(products, 1) + 1
    On Error GoTo 0

    If currentSize < 0 Then currentSize = 0
    
    ReDim tempMatrix(0 To currentSize, 0 To 1)
    
    If currentSize > 0 Then
        For i = 0 To UBound(products, 1)
            tempMatrix(i, 0) = products(i, 0)
            tempMatrix(i, 1) = products(i, 1)
        Next i
    End If
        
    
    ' 向临时数组添加新产品
    tempMatrix(currentSize, 0) = name
    tempMatrix(currentSize, 1) = price
    
  
    products = tempMatrix

End Sub

Private Sub GenerateQuotation_Click()
    Call addFinalPrice    
    Call SaveAsPdf
End Sub

Sub addFinalPrice()
    Dim textMatrixNames As Variant
    Dim textMatrixPrices As Variant
 
    For i = LBound(products) To UBound(products)
        textMatrixNames = textMatrixNames & products(i, 0) & vbCrLf
        textMatrixPrices = textMatrixPrices & Format(products(i, 1), "Currency") & vbCrLf
    Next i
    
    replaceText "<<AllProductsNames>>", textMatrixNames
    replaceText "<<AllProductsPrices>>", textMatrixPrices
End Sub

问题分析与解决方案 #

核心原因 #

模板中的全局变量products()属于模板的VBA项目上下文，而基于模板新建的文档会生成独立的VBA执行环境。点击文档中的按钮时，代码大概率在文档自身的上下文运行，无法访问模板上下文存储的数组数据；手动F5执行时是在模板的VBA编辑器中直接运行，能直接访问模板上下文的数组，因此功能正常。

修复方案 #

方案1：将数组数据存储到文档自定义属性

改用文档的CustomDocumentProperties存储产品数据，数据会随文档保存，且在文档上下文可直接访问：

' 替换原AddProduct过程
Sub AddProduct(name As Variant, price As Variant)
    Dim productList As String
    ' 读取现有产品列表，无则初始化
    On Error Resume Next
    productList = ActiveDocument.CustomDocumentProperties("ProductList").Value
    On Error GoTo 0
    ' 用|分隔名称和价格，用换行区分不同产品
    productList = productList & name & "|" & price & vbCrLf
    ' 更新或创建文档自定义属性
    On Error Resume Next
    ActiveDocument.CustomDocumentProperties.Add _
        Name:="ProductList", LinkToContent:=False, _
        Type:=msoPropertyTypeString, Value:=productList
    If Err.Number <> 0 Then
        ActiveDocument.CustomDocumentProperties("ProductList").Value = productList
    End If
End Sub

' 替换原addFinalPrice过程
Sub addFinalPrice()
    Dim productList As String
    Dim products() As String
    Dim textMatrixNames As String
    Dim textMatrixPrices As String
    Dim i As Integer
    
    On Error Resume Next
    productList = ActiveDocument.CustomDocumentProperties("ProductList").Value
    On Error GoTo 0
    
    If productList <> "" Then
        products = Split(productList, vbCrLf)
        ' 排除最后一个空行
        For i = LBound(products) To UBound(products) - 1
            Dim productInfo() As String
            productInfo = Split(products(i), "|")
            textMatrixNames = textMatrixNames & productInfo(0) & vbCrLf
            textMatrixPrices = textMatrixPrices & Format(productInfo(1), "Currency") & vbCrLf
        Next i
    End If
    
    replaceText "<<AllProductsNames>>", textMatrixNames
    replaceText "<<AllProductsPrices>>", textMatrixPrices
End Sub

方案2：确保按钮绑定到模板上下文

在模板中插入按钮时，选择“宏”时直接指定模板中的GenerateQuotation_Click，避免创建文档级宏；或者将按钮点击事件写在模板的ThisDocument模块中，确保代码在模板上下文执行，同时通过ActiveDocument访问当前文档对象。

方案3：模块级变量配合文档初始化事件

在模板的标准模块中定义数组，同时在模板的Document_New事件中初始化数组，确保新建文档时继承模板的变量状态。注意：这种方式仅适用于临时数据，文档保存关闭后变量数据会丢失。

内容的提问来源于stack exchange，提问作者george nunes