Eplan API插件是针对EPLAN电气设计软件打造的，用于开发自定义功能和自动化任务。通过使用EPLAN API，用户可以通过编程方式与EPLAN软件进行交互，以实现定制化的电气设计和自动化流程。
EPLAN API提供了多个编程接口，包括 COM、.NET和C++等，以满足不同开发需求和编程技术的选择。用户可以使用这些接口访问和操作EPLAN软件中的各种对象和数据，如项目、电路图、设备、符号、线路等，以及进行创建、修改和删除等操作。
通过EPLAN API，用户可以自动化执行繁琐重复的任务，提高工作效率和准确性。例如，可以编写脚本或程序来自动生成电路图、创建数据报告、导入导出数据等。还可以与其他软件和系统集成，实现数据的无缝传输和集成。
EPLAN API的开发需要一定的编程知识和技能，熟悉相关编程语言和开发环境。EPLAN还提供了详细的开发文档和示例代码，以帮助开发人员进行接口的学习和使用。
总之，Eplan API插件为开发人员提供了丰富的接口和功能，使他们能够定制和扩展EPLAN电气设计软件，以满足各种特定需求和自动化任务。通过利用EPLAN API，用户可以提高工作效率、减少错误，并实现更高级别的电气设计和自动化流程。
2、直接编辑，“直接编辑”功能用于直接编辑文本，比如设备标识符、功能文本或部件编号。激活该功能时，在原理图中直接点击元件，此时不会弹出设备属性对话框，而是直接进入编辑状态，便于快速地修改文本。
3、项目方案选项，“项目方案选项”功能用于定义设备或机器的可选项，在EPLAN 中，将所有的可选项在导航器中创建为变量，通过简单勾选来设定它的显示和隐藏。只有激活的选项才会在图纸中显示，在生成报表的时候予以考虑。
4、逆向设计，通过”逆向设计“功能，无论在项目的何处进行修改，其它相关联的地方都会自动更改，无论使用的是面向图形，还是面向对象的工作方式。工作方式与设计的流程密切相关，在项目进行过程中可以随时切换。
5、动态报表，使用动态报表，可以将报表放在原理图中；也可以将多个报表合并到同一页上。
6、宏变量/宏值集，仅需轻点鼠标，就能对整个宏回路进行替换(宏变量)，甚至可以对整个回路中的参数进行快速分配(宏值集)，既高效、又低错。
-用户指南向您介绍如何设置开发环境并开始开发或使用更高级的功能
-API参考。它详细列出并详细描述了EPLANAPI的所有名称空间，类方法等。
API支持安装程序以HTML和Microsoft帮助查看器格式安装API帮助。通过这种方式，它可以在线访问或从磁盘本地访问（即在离线模式下）。
API帮助格式
在脱机模式下，可以通过桌面上的快捷方式（HTML格式）或VisualStudio（Microsoft帮助查看器）访问API帮助，
后者是VisualStudio使用的标准帮助系统格式。这样它可以作为本地安装的另一个VS帮助来访问，即按F1键。
有时，安装程序无法在VisualStudio下正确注册帮助。在这种情况下，可以使用以下步骤手动完成：
a）使用帮助->从VisualStudio中添加和删除帮助内容启动MicrosoftHelpViewer
b）在'管理内容'选项卡中，请选择磁盘安装源，然后从安装了API帮助的目录中浏览helpcontentsetup.msha文件。默认情况下应该在％ProgramData％\EPLAN\API-Support\\doc中
c）选择'添加'链接，然后按'更新'按钮
d）确保通过在MicrosoftHelpViewer中浏览EPLANAPI内容来注册帮助。
e）为了使用与VisualStudio集成的帮助，请将首选帮助设置为帮助查看器：
2、开发环境
这些主题介绍了如何使用集成开发环境创建EPLANAPI应用程序。
开发EPLANAPI应用程序的首选方法是使用.Net编程语言C＃（CSharp），托管C++，VisualBasic.Net或J＃直接在.Net项目中引用API程序集。您可以通过使用文本编辑器并从DOS框中调用编译器来执行此操作，如“在CSharp中创建加载项”或“在VisualBasic.Net中创建加载项”中所述。
更方便的开发方式涉及使用集成开发环境（IDE）。我们推荐使用MicrosoftVisualStudio.Net，但也有像SharpDevelop这样的免费开发环境。“EPLAN.NetAPI”主题介绍了如何在VisualStudio中启动API项目。
EPLANAPI已针对MicrosoftWindows7,8和10进行了明确的测试和发布。
不建议在单独的子线程中使用EPLANAPI。这可能会导致问题，因为此类配置未经API设计人员测试或预测。
调试应用程序
警告：当前在调试应用程序时，w3u.exe进程在调试开始时分离。发生这种情况是因为ElectricP8文件夹中的w3u.exe调用了“平台”文件夹中的eplan.exe。为了继续调试，请附上“Platform”文件夹中的eplan程序。另一种解决方案是在'Platform'文件夹中开始调试eplan.exe，并使用'Variant'参数，例如：
/Variant:"Electric P8"
3、EPLAN.NetAPI
EPLANAPI是使用Microsoft®.Net4.5.2技术创建的。
要使用EPLANAPI开发应用程序，我们推荐使用MicrosoftVisualStudio2015,2013,2012。但是，它也应该适用于Microsoft.Net框架4.5.2的其他开发环境。然而，EPLANAPI未经其他IDE测试，而不是上面提到的那个。
要在MicrosoftVisualStudio2015中启动新的EPLANAPI项目，请选择菜单点File>New>Project...。在“新建项目”对话框中，首先选择要使用的编程语言（C＃，VisualBasic或C++）。
接下来你决定，你想写哪种类型的应用程序：
对于加载项，您可以选择“类库”项目或使用EPLAN提供的加载项向导。主题“在VisualStudio中创建加载项”中介绍了如何继续使用加载项向导。如果您想在不使用向导的情况下创建加载项，只需将引用添加到API程序集。您至少必须引用Eplan.EplApi.AF.dll和Eplan.EplApi.Base.dll。阅读有关在加载项下面的主题中创建加载项的更多信息。在“配置属性>调试”下的项目设置中，添加W3u.exe作为启动程序（或带有'Variant'参数的Eplan.exe），并确保在创建后将创建的dll复制到bin文件夹中。
例如，对于离线程序，您可以创建一个新的Windows应用程序项目，并按照“在其他进程中使用EPLANAPI程序集”主题中的描述继续操作。确保路径设置为EPLANbin目录，或者您的代码项目的工作目录分别设置，否则可能会找不到dll。
备注
使用旧的EPLANAPI需要适合此版本框架的环境，
例如EPLANAPI的2.0.9版本是为Microsoft.NetFramework3.5开发的。
确保不要混合使用不同框架的EPLANAPI程序集。
4、API框架
API框架提供了将API加载项集成到EPLAN，处理脚本以及使用EPLAN系统的基础技术（例如，创建操作，编写系统消息和管理EPLAN设置。该框架包含名称空间Eplan.EplApi.ApplicationFramework，Eplan.EplApi.Base，Eplan.EplApi.EServices，Eplan.EplApi.Gui，Eplan.EplApi.Scripting和Eplan.EplApi.System。
框架没有提供电子技术功能。
5、API DataModel
电工技术数据模型（Eplan.EplApi.DataModel命名空间）包括属于EPLAN项目的所有类/对象，例如项目本身，页面，函数，布局等。每个类都从基类StorableObject派生并具有其特定属性。与EPLAN21数据模型相反，EPLAN不严格区分图形信息和逻辑信息。例如，一个页面也保留了功能（逻辑）以及展示位置（图形）的记录。没有设备对象，它存储具有相同设备标签的功能。
注意类Function被命名为VisualBasic的关键字。为了在VB中不出现编译错误，您需要始终使用其完整的名称空间来引用一个Function对象：Eplan.EplApi.DataModel.Function或方括号：[Function]。我们建议您在不再需要时释放Datamodel对象。尤其是在设置大量属性的循环中。确保垃圾收集器可以通过经常调用System.GC.WAItForPendingFinalizers（）来清理这些对象。
请注意，通常数据模型对象以毫米为单位存储长度值，尺寸根据图形坐标系统存储。
6、API高级电子技术服务
Eplan.EplApi.HEServices命名空间主要包含不直接连接到数据模型的功能。 有用于备份项目和主数据，创建报告或打印的类。 EPLAN的很多模块都在这个名称空间中表示，如标签模块和部件管理。
功能介绍
1、产品模块，EPLAN的重要业务之一是提供基于流程的工程解决方案，供您日后之需！EPLAN Electric P8可根据您的需求进行灵活定制，比如说，您打算优化当前电气设计，或将设计工具集成到现有的工程流程中。2、直接编辑，“直接编辑”功能用于直接编辑文本，比如设备标识符、功能文本或部件编号。激活该功能时，在原理图中直接点击元件，此时不会弹出设备属性对话框，而是直接进入编辑状态，便于快速地修改文本。
3、项目方案选项，“项目方案选项”功能用于定义设备或机器的可选项，在EPLAN 中，将所有的可选项在导航器中创建为变量，通过简单勾选来设定它的显示和隐藏。只有激活的选项才会在图纸中显示，在生成报表的时候予以考虑。
4、逆向设计，通过”逆向设计“功能，无论在项目的何处进行修改，其它相关联的地方都会自动更改，无论使用的是面向图形，还是面向对象的工作方式。工作方式与设计的流程密切相关，在项目进行过程中可以随时切换。
5、动态报表，使用动态报表，可以将报表放在原理图中；也可以将多个报表合并到同一页上。
6、宏变量/宏值集，仅需轻点鼠标，就能对整个宏回路进行替换(宏变量)，甚至可以对整个回路中的参数进行快速分配(宏值集)，既高效、又低错。
使用帮助
1、您正在阅读的文档分为两部分：-用户指南向您介绍如何设置开发环境并开始开发或使用更高级的功能
-API参考。它详细列出并详细描述了EPLANAPI的所有名称空间，类方法等。
API支持安装程序以HTML和Microsoft帮助查看器格式安装API帮助。通过这种方式，它可以在线访问或从磁盘本地访问（即在离线模式下）。
API帮助格式
在脱机模式下，可以通过桌面上的快捷方式（HTML格式）或VisualStudio（Microsoft帮助查看器）访问API帮助，
后者是VisualStudio使用的标准帮助系统格式。这样它可以作为本地安装的另一个VS帮助来访问，即按F1键。
有时，安装程序无法在VisualStudio下正确注册帮助。在这种情况下，可以使用以下步骤手动完成：
a）使用帮助->从VisualStudio中添加和删除帮助内容启动MicrosoftHelpViewer
b）在'管理内容'选项卡中，请选择磁盘安装源，然后从安装了API帮助的目录中浏览helpcontentsetup.msha文件。默认情况下应该在％ProgramData％\EPLAN\API-Support\\doc中
c）选择'添加'链接，然后按'更新'按钮
d）确保通过在MicrosoftHelpViewer中浏览EPLANAPI内容来注册帮助。
e）为了使用与VisualStudio集成的帮助，请将首选帮助设置为帮助查看器：
2、开发环境
这些主题介绍了如何使用集成开发环境创建EPLANAPI应用程序。
开发EPLANAPI应用程序的首选方法是使用.Net编程语言C＃（CSharp），托管C++，VisualBasic.Net或J＃直接在.Net项目中引用API程序集。您可以通过使用文本编辑器并从DOS框中调用编译器来执行此操作，如“在CSharp中创建加载项”或“在VisualBasic.Net中创建加载项”中所述。
更方便的开发方式涉及使用集成开发环境（IDE）。我们推荐使用MicrosoftVisualStudio.Net，但也有像SharpDevelop这样的免费开发环境。“EPLAN.NetAPI”主题介绍了如何在VisualStudio中启动API项目。
EPLANAPI已针对MicrosoftWindows7,8和10进行了明确的测试和发布。
不建议在单独的子线程中使用EPLANAPI。这可能会导致问题，因为此类配置未经API设计人员测试或预测。
调试应用程序
警告：当前在调试应用程序时，w3u.exe进程在调试开始时分离。发生这种情况是因为ElectricP8文件夹中的w3u.exe调用了“平台”文件夹中的eplan.exe。为了继续调试，请附上“Platform”文件夹中的eplan程序。另一种解决方案是在'Platform'文件夹中开始调试eplan.exe，并使用'Variant'参数，例如：
/Variant:"Electric P8"
3、EPLAN.NetAPI
EPLANAPI是使用Microsoft®.Net4.5.2技术创建的。
要使用EPLANAPI开发应用程序，我们推荐使用MicrosoftVisualStudio2015,2013,2012。但是，它也应该适用于Microsoft.Net框架4.5.2的其他开发环境。然而，EPLANAPI未经其他IDE测试，而不是上面提到的那个。
要在MicrosoftVisualStudio2015中启动新的EPLANAPI项目，请选择菜单点File>New>Project...。在“新建项目”对话框中，首先选择要使用的编程语言（C＃，VisualBasic或C++）。
接下来你决定，你想写哪种类型的应用程序：
对于加载项，您可以选择“类库”项目或使用EPLAN提供的加载项向导。主题“在VisualStudio中创建加载项”中介绍了如何继续使用加载项向导。如果您想在不使用向导的情况下创建加载项，只需将引用添加到API程序集。您至少必须引用Eplan.EplApi.AF.dll和Eplan.EplApi.Base.dll。阅读有关在加载项下面的主题中创建加载项的更多信息。在“配置属性>调试”下的项目设置中，添加W3u.exe作为启动程序（或带有'Variant'参数的Eplan.exe），并确保在创建后将创建的dll复制到bin文件夹中。
例如，对于离线程序，您可以创建一个新的Windows应用程序项目，并按照“在其他进程中使用EPLANAPI程序集”主题中的描述继续操作。确保路径设置为EPLANbin目录，或者您的代码项目的工作目录分别设置，否则可能会找不到dll。
备注
使用旧的EPLANAPI需要适合此版本框架的环境，
例如EPLANAPI的2.0.9版本是为Microsoft.NetFramework3.5开发的。
确保不要混合使用不同框架的EPLANAPI程序集。
4、API框架
API框架提供了将API加载项集成到EPLAN，处理脚本以及使用EPLAN系统的基础技术（例如，创建操作，编写系统消息和管理EPLAN设置。该框架包含名称空间Eplan.EplApi.ApplicationFramework，Eplan.EplApi.Base，Eplan.EplApi.EServices，Eplan.EplApi.Gui，Eplan.EplApi.Scripting和Eplan.EplApi.System。
框架没有提供电子技术功能。
5、API DataModel
电工技术数据模型（Eplan.EplApi.DataModel命名空间）包括属于EPLAN项目的所有类/对象，例如项目本身，页面，函数，布局等。每个类都从基类StorableObject派生并具有其特定属性。与EPLAN21数据模型相反，EPLAN不严格区分图形信息和逻辑信息。例如，一个页面也保留了功能（逻辑）以及展示位置（图形）的记录。没有设备对象，它存储具有相同设备标签的功能。
注意类Function被命名为VisualBasic的关键字。为了在VB中不出现编译错误，您需要始终使用其完整的名称空间来引用一个Function对象：Eplan.EplApi.DataModel.Function或方括号：[Function]。我们建议您在不再需要时释放Datamodel对象。尤其是在设置大量属性的循环中。确保垃圾收集器可以通过经常调用System.GC.WAItForPendingFinalizers（）来清理这些对象。
请注意，通常数据模型对象以毫米为单位存储长度值，尺寸根据图形坐标系统存储。
6、API高级电子技术服务
Eplan.EplApi.HEServices命名空间主要包含不直接连接到数据模型的功能。 有用于备份项目和主数据，创建报告或打印的类。 EPLAN的很多模块都在这个名称空间中表示，如标签模块和部件管理。
