快速开始

总览

活字格作为低代码开发平台，提供了强大的编程扩展能力，此教程旨在帮助快发者，轻松快速的了解如何开发活字格的插件

技能要求

开发活字格插件，对开发人员需要使用两种语言，C#和JavaScript。不过不用担心，开发活字格插件并不需要很深厚的技术能力，只要了解最基本的语法就完全够用。如果你不了解这两种语言或者之一，但是以前接触过其他编程语言如（Java，Python, C, C++）等，那么学习C#和JavaScript到可以开发活字格插件的程度大概几天就可以了。甚至不经过刻意的学习，只需要跟着教程示例代码尝试，也可以很快上手活字格插件开发。

1. C#
   1. 用于定义插件类型及属性
   2. 如果编写服务端命令插件，需要编写执行逻辑
2. JavaScript
   1. 用于实现单元格插件的渲染和交互逻辑
   2. 用于实现命令插件的执行逻辑

环境准备

开发活字格插件之前，需要下载并安装活字格设计器及集成开发环境。

插件开发只安装活字格设计器即可，不必须安装活字格服务器，推荐安装至默认路径

集成开发环境，这里推荐免费下载安装 VisualStudio 2022 社区版

安装VisualStudio 2022 社区版步骤

1. 打开链接https://visualstudio.microsoft.com/zh-hans/vs/community/，点击“下载Visual Studio按钮”

2. 下载后双击打开，看到以下界面, 勾选".Net 桌面开发"，其他保持默认配置，点击Next即可
   如果提示系统版本不支持，需要升级Windows

   1. 系统要求
      1. Windows 11 版本 21H2 或更高版本：家庭版、专业版、专业教育版、专业工作站版、企业版和教育版
      2. Windows 10 版本 1909 或更高版本：家庭版、专业版、教育版和企业版。

下载插件构建器

活字格插件构建器是一个开源项目，使用插件构建器构建活字格插件项目会获得以下好处

1. 自动添加活字格插件开发所需依赖，生成个工程开箱即用，直接找到对应的文件添加业务逻辑即可
2. 添加前端接口描述文件 (.d.ts)。编写js代码也可以显示方法智能提示
3. 支持前端JS代码热更新（不用重启活字格设计器，修改js文件后保存再刷新页面，即可应用最新变更）
4. 支持Cs代码热更新（编译插件工程后，不用重新安装插件，只需重启活字格设计器即可应用最新变更）
5. 自动打包（编译后自动在bin目录下生成打包好的 zip 插件包）

下载活字格插件构建器步骤

1. 打开https://gitee.com/grape-city-software/forguncy-plugin-project-creator， 点击最新的发行版
   
2. 打开发行版页面后点击下载 forguncyPluginBuilder.zip 文件
   
3. 解压缩后可以看到两个子文件
   
4. 在bin目录下找到 ForguncyPluginCreator.exe 文件，双击打开
5. 可以看到以下界面
   
6. 直接点击OK
7. 在“文档\HZG-Plugins\MyPlugin”目录下找到“MyPlugin.sln”文件，双击打开
   
8. 在VisualStudio 里找到并点击菜单 “生成->生成解决方案”。
   
9. 编译成功后，打开活字格设计器，在单元格类型选择下拉列表中可以看到多了一个单元格类型“我的插件单元格”。恭喜你，第一个插件已经开发完成了。
   

更新: 2023-09-19 15:36:40
原文: https://www.yuque.com/robert-bh51n/ea8l6c/iz7iot1gw3k5rshg