ExcelDna:如何判断当前激活的是否为普通工作表?
判断当前激活对象是否为普通工作表,需要同时满足两个条件:能转换为 Excel.Worksheet,且 Type 等于 Excel.XlSheetType.xlWorksheet。这样就能排除 Excel 4.0 宏表,无需调用 GET.DOCUMENT(3)。
Ribbon 通过 getEnabled 使用判断结果,并在工作表或窗口状态变化后刷新缓存。
为什么原来的判断不够准确
TypeOf sheet Is Excel.Worksheet 只检查对象是否支持 Worksheet 接口。宏表也可能通过这个接口访问,所以即使再检查 TypeName(sheet),仍然无法确认它是否为普通工作表。
应读取 Worksheet.Type,它返回 XlSheetType:
| 工作表类型 | 枚举值 | 数值 |
|---|---|---|
| 普通工作表 | xlWorksheet | -4167 |
| Excel 4.0 宏表 | xlExcel4MacroSheet | 3 |
| Excel 4.0 国际宏表 | xlExcel4IntlMacroSheet | 4 |
| 图表工作表 | xlChart | -4109 |
| 对话框工作表 | xlDialogSheet | -4116 |
这些数值来自 XlSheetType 枚举,与 GET.DOCUMENT(3) 的返回值采用不同的编号,不能把 Worksheet.Type 与 1 比较。
判断普通工作表的代码
在 VB.NET 文件顶部添加:
Imports System
Imports System.Diagnostics
Imports ExcelDna.Integration
Imports Excel = Microsoft.Office.Interop.Excel
用下面的函数替换原来的判断:
Private Function IsNormalWorksheetActive() As Boolean
Try
Dim app As Excel.Application =
TryCast(ExcelDnaUtil.Application, Excel.Application)
If app Is Nothing Then Return False
If app.Workbooks.Count = 0 OrElse
app.ActiveWindow Is Nothing Then
Return False
End If
Dim sheet As Excel.Worksheet =
TryCast(app.ActiveSheet, Excel.Worksheet)
If sheet Is Nothing Then Return False
Return sheet.Type = Excel.XlSheetType.xlWorksheet
Catch ex As Exception
Debug.WriteLine(ex.ToString())
Return False
End Try
End Function
函数分两步检查:
TryCast排除图表工作表等不能转换为Excel.Worksheet的对象。sheet.Type排除宏表等通过Worksheet接口访问的非普通工作表。
没有活动窗口、没有活动工作表或读取失败时,函数都返回 False。
将结果接入 Ribbon
为需要限制的按钮设置 getEnabled。例如,在现有 Ribbon XML 中配置:
<customUI xmlns="http://schemas.microsoft.com/office/2006/01/customui"
onLoad="OnRibbonLoad">
<ribbon>
<tabs>
<tab id="worksheetToolsTab" label="工作表工具">
<group id="worksheetToolsGroup" label="操作">
<button id="worksheetCommand"
label="工作表操作"
getEnabled="GetWorksheetCommandEnabled" />
</group>
</tab>
</tabs>
</ribbon>
</customUI>
接入时保留按钮原有的 onAction。多个控件需要同样的限制时,可以共用一个 getEnabled 回调。
在文件顶部再添加:
Imports Office = Microsoft.Office.Core
将以下成员和前面的判断函数一起放入现有的 ExcelRibbon 派生类中。Ribbon 回调必须是 Public 方法。
Private _ribbon As Office.IRibbonUI
Private WithEvents _app As Excel.Application
Public Sub OnRibbonLoad(ribbon As Office.IRibbonUI)
_ribbon = ribbon
_app = TryCast(ExcelDnaUtil.Application, Excel.Application)
End Sub
Public Function GetWorksheetCommandEnabled(
control As Office.IRibbonControl) As Boolean
Return IsNormalWorksheetActive()
End Function
Private Sub OnSheetActivate(sh As Object) _
Handles _app.SheetActivate
RequestRibbonRefresh()
End Sub
Private Sub OnWindowActivate(
wb As Excel.Workbook,
wn As Excel.Window) Handles _app.WindowActivate
RequestRibbonRefresh()
End Sub
Private Sub OnWindowDeactivate(
wb As Excel.Workbook,
wn As Excel.Window) Handles _app.WindowDeactivate
RequestRibbonRefresh()
End Sub
Private Sub OnWorkbookBeforeClose(
wb As Excel.Workbook,
ByRef cancel As Boolean) Handles _app.WorkbookBeforeClose
RequestRibbonRefresh()
End Sub
Private Sub RequestRibbonRefresh()
ExcelAsyncUtil.QueueAsMacro(
Sub()
If _ribbon IsNot Nothing Then
_ribbon.Invalidate()
End If
End Sub)
End Sub
Excel 会缓存 Ribbon 回调的返回值。因此,即使判断函数正确,切换到宏表后,按钮也可能仍显示为启用状态。调用 Invalidate() 后,Excel 才会重新获取相关控件的状态,具体机制见 Excel-DNA 的 Ribbon 说明。
这里通过 QueueAsMacro 将刷新排入队列,让回调在执行时重新查询活动工作表,避免在关闭工作簿等事件中提前读取正在变化的状态。Excel-DNA 的示例说明也介绍了如何通过该方法进入适合访问 Excel 对象模型的上下文。
代码使用 Microsoft.Office.Core 的 Ribbon 接口,项目需要引用相应的 Office 和 Excel Interop 程序集。加载项卸载时应解除事件订阅。采用这里的 WithEvents 写法时,可以在清理逻辑中将 _app 和 _ribbon 设为 Nothing。
如何排查 ExecuteExcel4Macro 始终返回 False
原代码的 Catch 会把所有异常都转换成 False。仅凭这个返回值,无法确定是宏调用失败、结果转换失败,还是其他 COM 访问出了问题。
排查时至少应保留异常信息:
Catch ex As Exception
Debug.WriteLine(ex.ToString())
Return False
End Try
如果调用正常返回,也可以记录 result 的值和运行时类型。缺少这些信息,就无法直接认定 Excel-DNA 不支持该调用,或将问题归因于某项 Excel 设置。
当前需求使用 Worksheet.Type 就能完成类型判断。含 VBA 的 .xlsm 文件中的普通工作表仍属于 xlWorksheet,工作簿含宏并不代表当前激活的是宏表。执行按钮操作前,最好再次调用判断函数,避免业务逻辑依赖尚未刷新的 Ribbon 状态。
备注:内容仅供参考。
