EPlan二次开发入门文档
一、开发环境介绍
开发EPLAN插件前,首先确认自己的EPLAN版本及.Net Framework版本。
EPLAN官方开发文档:
https://www.eplan.help/en-US/infoportal/content/api/2.9/index.html
建议使用EPLAN 2.9和VisualStudio 2022,因此.Net Framework选4.7.2即可。
二、新建项目
首先创建个.NET Framework 类库项目:
配置.NET Framework版本选择对应EPLAN版本,EPLAN 2.9是.NET Framework 4.7.2。
接下来要按照Eplan Electric P8 API的命名约定,将程序集更改为.EplAddin. 规则的名称,否则Eplan Electric P8 无法找到和加载生成的Dll插件。
然后引用下开发所必要的外部程序,位置在EPLAN启动目录,下图中选中区域为必需的dll,其它可按需引入。
解决方案资源管理器中的默认Class1.cs,可以按F2重命名为此项目合适的名称,此名称不会影响所生成Dll的插件名,Dll的名称是在上一步程序集名称中确定的,接下来为类添加接口。
EPLAN中的每个插件,也就是我们正在创建的类,需要一个特定的类来管理。此类必须实现由IEplAddIn接口声明的函数,因此我们将类实现下接口:
using Eplan.EplApi.ApplicationFramework;
using System;using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace EplApiDemo
{
/// <summary>
/// Demo类
/// </summary>
public class EplApiDemo : IEplAddIn
{
public bool OnExit()
{
throw new NotImplementedException();
}
public bool OnInit()
{
throw new NotImplementedException();
}
public bool OnInitGui()
{
throw new NotImplementedException();
}
public bool OnRegister(ref bool bLoadOnStart)
{
throw new NotImplementedException();
}
public bool OnUnregister()
{
throw new NotImplementedException();
}
}
}
经过如上操作后,按下F6键,在项目目录:.\bin\Debug下会生成一个Eplan.EplAddin.Demo.dll。
三、调试环境
为了实现在EPLAN中断调试,就需要将VS中附加到EPLAN进程中,在VS中右键项目>属性,在调试项做如下设置:
注意:
1、启动外部程序:选择Platform下的Eplan.exe
2、命令行参数里“/NoLicenseDialog”可以避免启动时弹出选择License版本对话框,“/Variant:"Electric P8"”可以设置启动的版本。多个参数空格隔开。
3、工作目录:选择Eplan安装目录,"D:\Program Files\EPLAN\Electric P8\2.9.4\Bin",一定要加,否则无法启动。
四、实际效果
按快捷键F10,启动调试。