获取Excel工作表函数参数描述的VSTO VB.NET实现方案问询

当然可以用VSTO实现这个功能！我之前做过类似的工具，核心是利用Excel对象模型里的Application.MacroOptions方法提取内置函数的参数描述，再配合反射验证函数有效性，避免报错。

核心思路 #

• 先验证输入的函数名称是否为Excel内置工作表函数，防止传入无效名称
• 调用Application.MacroOptions获取该函数的参数描述数组
• 根据传入的参数位置（注意：参数位置从1开始对应第一个参数）返回对应描述

VB.NET代码实现 #

Imports Microsoft.Office.Interop.Excel
Imports System.Reflection

Public Class ExcelFunctionParameterHelper
    Private _excelApp As Application

    Public Sub New(excelApp As Application)
        _excelApp = excelApp
    End Sub

    ''' <summary>
    ''' 获取指定工作表函数的指定位置参数描述
    ''' </summary>
    ''' <param name="functionName">Excel内置工作表函数名称（如VLOOKUP, SUM）</param>
    ''' <param name="paramIndex">参数位置（从1开始计数）</param>
    ''' <returns>参数描述文本，若函数不存在或参数位置无效则返回空字符串</returns>
    Public Function GetParameterDescription(functionName As String, paramIndex As Integer) As String
        ' 1. 验证函数是否为内置工作表函数
        Dim worksheetFunctionType As Type = GetType(WorksheetFunction)
        Dim functionMethod As MethodInfo = worksheetFunctionType.GetMethod(functionName, BindingFlags.Public Or BindingFlags.Instance)

        If functionMethod Is Nothing Then
            Return "" ' 函数不存在
        End If

        ' 2. 验证传入的参数位置是否合法
        Dim paramCount As Integer = functionMethod.GetParameters().Length
        If paramIndex < 1 OrElse paramIndex > paramCount Then
            Return "" ' 参数位置超出范围
        End If

        ' 3. 使用MacroOptions获取参数描述数组
        Try
            Dim argDescriptions As Object() = _excelApp.MacroOptions(functionName, ArgDescriptions:=Type.Missing)
            If argDescriptions IsNot Nothing AndAlso argDescriptions.Length >= paramIndex Then
                Return argDescriptions(paramIndex - 1).ToString() ' 数组索引从0开始，参数位置从1开始
            End If
        Catch ex As Exception
            ' 处理特殊函数无法获取描述的异常
            Return ""
        End If

        Return ""
    End Function
End Class

使用示例 #

在你的VSTO插件中，可以这样调用这个工具类：

' 获取当前Excel应用实例
Dim excelApp As Application = Globals.ThisAddIn.Application
Dim helper As New ExcelFunctionParameterHelper(excelApp)

' 示例：获取VLOOKUP函数第2个参数的描述
Dim desc As String = helper.GetParameterDescription("VLOOKUP", 2)
MsgBox(desc) ' 中文Excel会显示"要在数据表第一列中查找的值"

注意事项 #

• 函数名称默认区分大小写，如果需要忽略大小写匹配，可以修改代码，遍历所有方法名进行不区分大小写的比对
• 返回的描述文本会跟随Excel的语言版本变化，中文Excel返回中文描述，英文版本返回英文描述
• 极少数特殊函数可能无法通过MacroOptions获取参数描述，建议在捕获异常后返回友好提示

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