API 接口
本页面向使用者介绍工作台暴露的三类接口:工作表函数、Ribbon 命令与数据接口。 完整的 .NET API 参考(类 / 方法 / XML 注释)由 DocFX 从源码自动生成,见下方说明。
工作表函数
在 Excel / WPS 单元格中直接调用:
| 函数 | 说明 |
|---|---|
HZZ_VERSION |
返回插件与运行时版本信息 |
HZZ_LOGPATH |
返回插件日志路径 |
HZZ_BOM_PARTS |
按生产令号返回零件明细表(序号 / 代号 / 零件名称 / 材料牌号 / 数量 / 材料型态) |
HZZ_BOM_GRADES |
按生产令号反查材料牌号 |
HZZ_BOM_ORDERS |
按材料牌号反查生产令号 |
HZZ_BOM_DB |
返回 BOM 数据库路径等基本信息 |
Ribbon 命令
Ribbon 按钮通过 onAction 回调分发到控制器,主要命令如下:
| 按钮 | 动作 | 说明 |
|---|---|---|
| 配置中心 | OnConfigCenter |
打开配置中心 |
| 规范化销售计划 | OnNormalizeWorkbook |
规范化当前工作簿 |
| 逐行补录(B01) | OnRowEntry |
打开逐行补录 |
| 销售计划→合格证清单 | OnSalesPlanImport |
导入生成合格证清单 |
| 分界线/末行跳转 | OnJumpSplitLine |
跳转到分界线或末行 |
| 自动编号 | OnAutoNumber |
执行合格证自动编号 |
| 记录参数 | OnRecordParameter |
记录编号参数 |
| 单次打印 | OnPrintSingle |
打印当前合格证 |
| 批量打印 | OnPrintBatch |
批量打印 |
| 批量打印·复用当前布局 | OnPrintBatchReuse |
复用当前布局批量打印 |
| 选模板+批量打印 | OnPrintBatchOneGo |
选模板后批量打印 |
| 选模板+单次打印 | OnPrintSingleOneGo |
选模板后单次打印 |
| 回放布局 | OnPickTemplate |
按模板还原打印布局 |
| 合格证扫描件 | OnMakeScan |
制作合格证扫描件 |
| 铭牌扫描件 | OnMakeNameplateScan |
制作铭牌扫描件 |
| 制作试压报告 | OnPressureTest |
生成试压报告 |
| 制作质保书 | OnQualityCert |
生成质保书 |
| 制作材质证明书 | OnMaterialCert |
生成材质证明书 |
| 材质库编辑 | OnOpenMaterialLibraryEditor |
打开材质库编辑器 |
| 查询报告登记 | OnQueryReportRegistry |
查询报告登记 |
| SQL查找外购数据 | OnSqlFind |
外购数据 SQL 查找 |
| 外购数据透视表 | OnPurchasingPivot |
生成外购数据透视表 |
| 刷新发货计划 | OnRefreshShipping |
刷新发货计划 |
| 导入BOM材料清单 | OnBomImport |
导入 BOM 材料清单 |
| 保存工作簿备份 | OnSaveBackup |
保存工作簿备份 |
| 打开铭牌数据库 | OnOpenNameplateDB |
打开铭牌数据库 |
数据接口
工作台操作以下几类本地数据源:
| 数据源 | 用途 |
|---|---|
cert.db |
合格证相关数据(SQLite,位于用户数据目录) |
bom.db |
BOM 零件 / 材料牌号数据(SQLite) |
material.db |
材质库数据(SQLite) |
| Access 工作簿 | 铭牌数据库等 Access 数据源 |
SignDB |
铭牌刻印机数据库(只读查询) |
内容模板管理接口
合格证内容模板管理(SjkContentManager)提供服务层接口,支持内容记录的 增删、停用切换、备份删除与检索。相关类型:
SjkContentManagerService— 内容模板管理门面SjkContentAdmin— 内容记录管理(停用切换 + 备份删除)SjkRecordSchema— 记录结构定义
完整 .NET API 参考
完整的 .NET API 参考(类型 / 成员 / XML 注释)由 DocFX 在发布流水线中自动生成。
进入后页面左侧为完整类型树(Core / AccessStore / Workbench 等命名空间),可逐级展开;XML 注释里的 <see cref> 交叉引用均为可点链接。
为什么不直接读 .xll:.xll 是 ExcelDNA 的原生宿主外壳,DocFX 的 metadata 段只认托管程序集(DLL)与其 XML 文档文件,读不了它。但这不需要 Windows 构建机——Workbench 的目标框架 net6.0-windows 在 Linux 上照常编译(CI 实证),流水线实际做的是:
dotnet build -c Release -p:GenerateDocumentationFile=true编出托管 DLL + XML 文档;- 整个构建输出目录拷到
docs-site/api-src/(含依赖程序集;再补 WindowsDesktop 引用包,供 DocFX 解析 WPF/WinForms 继承链); - DocFX
metadata段按 glob 只读我们的四个程序集,生成reference/下的参考页。
docfx.json 中的实际配置:
"metadata": [
{
"src": [{ "src": "api-src", "files": ["HeZhengZheng*.dll"] }],
"dest": "reference"
}
]
生成范围约 500 个公开类型(Core 纯逻辑层 + Workbench 宿主层 + AccessStore / AccessWriter 数据访问);XML 注释里的 <see cref> 交叉引用渲染为可点链接。源码改动的提交经夜间流水线自动重建,参考页与代码保持同步。