源码
教程完整版word和项目源码下载:
https://pan.baidu.com/s/1ufSfrzU5XKlCa9nhyp9tqQ
开发前准备
1. 操作系统
在Win10系统中引用WPS的dll文件可能会受到系统权限限制的问题,可以尝试在Administrator账户中安装WPS Office 2016专业版及进行后续开发。如果使用Win7系统,比较顺利
2. IDE集成开发环境
Microsoft Visual Studio 2017 Community 社区免费版
3. WPS Office 2016
- WPS Office 2016专业版。专业版无需**也可进行开发,推荐
- WPS Office 2016个人版。个人版需运行专业版自带的WPSOfficePIA.exe注册程序集后方可正常引用WPS的相关DL
创建项目
1. 启动Visual Studio-文件-新建-项目
2. 已安装→Visual C#-类库(.NET Framework)→输入名称→选择框架→确定
生成的新项目如下图
3. 在解决方案资源管理器中的项目上右键→属性→应用程序→程序集信息
4. 修改相应信息→勾选“使程序集COM可见”→ 确定
5. 切换到“生成”→勾选“为COM互操作注册”
6. 切换到“调试”→勾选“启动外部程序”→浏览→找到WPS安装文件夹中的相应exe程序
7. 切换到“签名”→勾选“为程序集签名”→新建**文件→输入名称→输入密码(也可不输入)→确定后完成项目属性设置
(三)添加引用
1. 在项目的“引用”上右键→添加引用
2. 选中“COM”→勾选“Kingsoft Add-In Designer”
3. 继续勾选“Upgrade WPS Presentation 3.0 Object Library(Beta)”→确定
提示: Upgrade WPS Office 3.0 Object Library对应的是WPS文字、Upgrade WPS Spreadsheets 3.0 Object Library对应的是WPS表格
4. 添加上述两个引用后会自动添加以下引用
提示:若添加后提示引用出错,可以尝试的解决方法有:
- 以Administrator账户登录Windows
- 以管理员身份运行Visual Studio
- 在Administrator账户中,以管理员身份安装WPS Office
- WPS Office个人版需要运行专业版中的 WPSOfficePIA.exe 以注册所引用的程序集
- 安装WPS Office专业版,安装时WPS会自动注册相关程序集
(四)添加资源文件
1. 在Properties上右键→添加→新建项→找到“资源文件”→输入或保持默认名称→添加
2. 在打开的Resource1.resx里→添加资源→添加新文本文件→输入名称→添加
3. 创建文本文件后→在打开的txt里粘贴以下代码
- <customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui">
- <ribbon startFromScratch="false">
- <tabs>
- <tab id="MyTab" label="我的插件" visible="true" insertAfterMso="TabDeveloper">
- <group id="Test" label= "组名称">
- <button id="Test" label="Hello" onAction="Test" getImage="GetRibbonImage" size="large"/>
- </group>
- </tab>
- </tabs>
- </ribbon>
- </customUI>
说明:
- tabs表示选项卡,id是“MyTab”,显示的名称是“我的插件”,在“开发工具”选项卡之后插入本选项卡
- group表示选项卡中的组,id是“Test”,名称是“组名称”
- button表示命令按钮,id是“Test”,名称是“Hello”,回调“Test”事件,从“GetRibbonImage”事件中获取按钮图标,按钮显示大尺寸
- Id、Label、onAction、getImage引号中的字符可以自定义,且保证唯一性
4. 在Resource1.resx中→添加资源→添加现有文件→选择图标文件
添加后的图标会显示在Resource1.resx中
5. 在Resource1.resx中添加相关资源后,在解决方案资源管理器中会自动生成Resources文件夹以及添加好的资源
提示:直接在项目所在的Resources文件夹中添加资源是不行的,资源文件并没有与项目产生关联,应该在VS中的Resource1.resx中添加
(五)修改主类
1. 点击解决方案资源管理器中默认的Class1.cs→输入自己插件的名称→回车后点”是”
提示:本文以“MyAddin”这个名称为例
2. 在Using别名区添加相关的引用名称
- using AddInDesignerObjects;
- using Office;
- using PowerPoint;
3. 在public class MyAddin后面添加调用接口
public class MyAddin : IDTExtensibility2, IRibbonExtensibility
4. 鼠标分别置于 IDTExtensibility2和IRibbonExtensibility上→点击黄色小灯泡→实现接口→VS会自动添加相关事件
5. 声明公共静态全局变量app和wpp
- public static PowerPoint.Application app = null;
- public static object wpp;
6. 在OnConnection事件中初始化wpp和app
- wpp = Application;
- app = wpp as PowerPoint.Application;
7. 在GetCustomUI事件中调用在Resource1.resx中添加的MyRibbon.txt
return Properties.Resource1.MyRibbon;
提示:调用资源文件时无需添加具体的扩展名
8. 添加GetRibbonImage事件,用于插件获取按钮图标
- public Bitmap GetRibbonImage(IRibbonControl ctrl)
- {
- switch (ctrl.Id)
- {
- case "Test":
- return Properties.Resource1.OKUI_1;
- }
- return null;
- }
提示:若要给别的按钮添加图标,在GetRibbonImage事件中补充相关代码。这里的Test是Hello按钮的id,OKUI_1是Resource1.resx中图标的名称
9. 鼠标置于Bitmap上→点击黄色小灯泡→点“Using System.Drawing;”,VS会在顶部的Using别名区自动添加相应的Using别名
10. 添加Test事件
- public void Test(IRibbonControl ctrl)
- {
- MessageBox.Show("Hello World");
- }
提示:MessageBox需要引用System.Windows.Forms。引用方法如下:
(1)在解决方案资源管理器中→在引用上右键→添加引用
(2)选中程序集→勾选“System.Windows.Forms”→确定
(3)在Using别名区引用System.Windows.Forms
using System.Windows.Forms;
(4)波浪线消失,我们可以正常调用消息框了
最后:其它几个事件可为空,也可根据自己需求添加代码。
(六)添加注册表信息
1. 安装
打开记事本→粘贴以下代码→另存为install.reg→双击install.reg文件安装插件
- Windows Registry Editor Version 5.00
- [HKEY_CURRENT_USERSOFTWAREMicrosoftOfficePowerPointAddinsWPP_test.MyAddin]
- "FriendlyName"="友好名称"
- "Description"="插件描述"
- "LoadBehavior"=dword:00000003
- "CommandLineSafe"=dword:00000001
- [HKEY_CURRENT_USERSoftwareKingsoftOfficeWPPAddinsWL]
- "WPP_test.MyAddin"=""
2. 卸载
打开记事本→粘贴以下代码→另存为uninstall.reg→双击uninstall文件卸载插件
- Windows Registry Editor Version 5.00
- [-HKEY_CURRENT_USERSOFTWAREMicrosoftOfficePowerPointAddinsWPP_test.MyAddin]
- [HKEY_CURRENT_USERSoftwareKingsoftOfficeWPPAddinsWL]
- "WPP_test.MyAddin"=-
说明:
(1)因为开发的是WPS演示的插件,所以注册表路径分别对应的是PowerPoint和WPP
需要注意的是,无论电脑中有没有安装Microsoft Office,都应这样写
(2)这里的WPP_test是插件项目的名称,MyAddin是插件主类库的名称
(3)若开发的是WPS文字、WPS表格的外接程序,则注册路径中:WPS文字对应的是Word和WPS;WPS表格对应的是Excel和ET
(七)运行
1. 点击VS中的启动按钮启动wpp.exe
2. 切换到“我的插件”选项卡→点击Hello按钮→弹出对话框→插件的基本创建就完成了
八)生成WPS演示所需的PIA
我参考的原文章:http://www.cnblogs.com/wangqiang3311/p/7206406.html
1. 打开WPS的安装文件夹,找到ksoapi.dll和wppapi.dll,复制到D盘下自己创建的PIA文件夹中,方便后续操作
提示:若需要生成WPS文字或WPS表格的PIA,对应的DLL分别是wpsapi.dl或etapi.dlll
2. 在开始菜单中,打开”VS 2017的开发人员命令提示符”
3. 输入cd “D:\PIA”,进入PIA文件夹中
4. 输入TlbImp ksoapi.dll (注意是tlbimp)后回车,会在PIA文件夹中生成Office.dll。输入TlbImp wppapi.dll 后回车,会在PIA文件夹中生成PowerPoint.dll
5. 这样我们就得到了Office.dll和PowerPoint.dll两个文件
(九)强签名
如果要将这两个Dll添加到GAC,还需要进行强签名(若用户是WPS专业版则不需要,为了兼容性,推荐进行强签名)。另外,如果项目中引用了第三方未签名的dll,则必须进行强签名才能引用
1. 输入sn -k test.pfx后回车,生成随机**对
提示:此处的test.pfx可以是任意名称,**文件扩展名也可以是.snk
2. 输入ildasm Office.dll /out:Office.il后回车,采用反汇编工具ildasm生成中间语言。
3. 输入ilasm /dll /res:Office.res /key:test.pfx Office.il /out:Office.dll后回车,采用汇编工具ilasm(注意不要看成ildasm)重新生成dll
4. PowerPoint.dll的强签名操作按照步骤2和3类推,输入以下命令
ildasm PowerPoint.dll /out:PowerPoint.il
ilasm /dll /res:PowerPoint.res /key:test.pfx PowerPoint.il/out:PowerPoint.dll
5. 重新生成dll后提示:Operation completed successfully,说明强签名成功
提示:经过强签名后的dll会覆盖原来未签名的dll
6. 强签名后的Office.dll和PowerPoint.dll
(十)部署
1. 将项目调试由Debug改为Release
提示:第一次切换Debug为Release,需要在项目属性中重新设置:生成(为COM互操作注册)、调试(启动外部程序)
2. 点启动按钮后关闭WPP,目的是为了让VS生成Release版的项目dll
3. 在项目上右键,点”在文件资源管理器中打开文件夹”
4. 双击bin文件夹,双击打开Release文件夹,将之前强签名后的dll复制过来
5. 将步骤(六)中创建的安装和卸载注册表文件也复制过来
6. 将NETFX 4.0 Tools文件夹复制过来(该文件夹在项目源码的Release文件夹中有)
7. 在记事本中输入已下代码,另存为”安装.bat”批处理文件
- @echo off
- @setbaseDir="%cd%"
- Echo.
- Echo 【1】导入注册表
- regedit/s %baseDir%\install.reg
- Echo.
- Echo 【2】注册类型
- C:\Windows\Microsoft.NET\Framework\v4.0.30319\RegAsm%baseDir%\WPP_test.dll /tlb:%baseDir%\WPP_test.tlb
- Echo.
- Echo 【3】添加程序集到GAC
- @SETGACUTIL="%baseDir%\NETFX 4.0 Tools\gacutil.exe"
- %GACUTIL%-i %baseDir%\WPP_test.dll
- %GACUTIL%-i %baseDir%\PowerPoint.dll
- %GACUTIL%-i %baseDir%\Office.dll
- pause
8. 在记事本中输入以下代码,另存为”卸载.bat”批处理文件
- @echo off
- @setbaseDir="%cd%"
- Echo.
- Echo 【1】从缓存中移除程序集
- @SETGACUTIL="%baseDir%\NETFX 4.0 Tools\gacutil.exe"
- rd /s /QC:\Windows\Microsoft.NET\assembly\GAC_MSIL\WPP_test
- rd /s /QC:\Windows\Microsoft.NET\assembly\GAC_MSIL\PowerPoint
- rd /s /QC:\Windows\Microsoft.NET\assembly\GAC_MSIL\Office
- Echo.
- Echo 【2】注销类型
- C:\Windows\Microsoft.NET\Framework\v4.0.30319\RegAsm/u %baseDir%\WPP_test.dll /tlb:%baseDir%\WPP_test.tlb
- Echo.
- Echo 【3】清除注册表
- regedit/s %baseDir%\uninstall.reg
- pause
说明:
(1)%cd%是bat文件当前文件夹路径;RegAsm是程序集注册工具,需要用户先安装Microsoft .Net Framework 4.0;gacutil.exe是全局程序集缓存工具,用户电脑一般没有,所以需要我们将NETFX 4.0 Tools文件夹附带在安装包里
(2)上面的”安装.bat”和”卸载.bat”中均默认注册或移出PowerPoint.dll和Office.dll,如果用户安装了同样也是本文章方法创建的插件,可能会影响其他插件使用。为保险起见,我们可以在”卸载.bat”文件中不要移除C:\Windows\Microsoft.NET\assembly\GAC_MSIL文件夹下的PowerPoint和Office文件夹。即在上方”卸载.bat”代码中去掉下面两句:
rd /s /QC:\Windows\Microsoft.NET\assembly\GAC_MSIL\PowerPoint
rd /s /QC:\Windows\Microsoft.NET\assembly\GAC_MSIL\Office
9. 将Release文件夹整体拷贝出来,打包发给用户。用户安装时,以管理员身份运行”安装.bat”即可
10. 用户安装失败常见原因
(1) 用户未安装Microsoft .Net Framework 4.0
(2) Win7以上系统,用户未以管理员身份运行安装.bat
(3) 安装文件夹所在路径中有空格,需去掉文件夹路径中的空格
注册表未成功添加插件信息,需要用户手动双击”install.reg”添加插件信息到注册表
标签:文件夹,插件,Office,C#,dll,添加,WPS,PowerPoint From: https://www.cnblogs.com/guangzhiruijie/p/17217942.html