您正在阅读的文档分为两个部分:

1. 用户指南用户指南部分向您介绍如何设置开发环境并开始开发或使用更高级的功能。

2. API参考

API参考部分详细列出并描述了EPLAN API的所有命名空间、类、方法等。

API支持安装程序以HTML和Microsoft帮助查看器格式安装API帮助。这样,可以在线访问或从磁盘本地访问(即离线模式)。

API帮助格式

在离线模式下,可以通过桌面上的快捷方式(HTML格式)或从Visual Studio(Microsoft帮助查看器)访问API帮助。

后者是Visual Studio使用的标准帮助系统格式。因此,可以像访问其他本地安装的VS帮助一样访问它,即按**[F1]**键。

有时,安装程序无法在Visual Studio中正确注册帮助。在这种情况下,可以使用以下步骤手动完成:

a) 从Visual Studio中使用帮助 > 添加和删除帮助内容启动Microsoft帮助查看器。

b) 在管理内容选项卡中,请选择磁盘安装源,然后浏览到安装API帮助的目录中的 helpcontentsetup.msha 文件。

默认情况下,它应该位于 %ProgramData%\\EPLAN\\O_Data\\API-Support\\<Eplan版本>\\doc

c) 选择添加链接并点击更新按钮。

d) 通过浏览Microsoft帮助查看器中的EPLAN API内容,确保帮助已注册。

e) 为了在Visual Studio中使用集成的帮助,请将首选帮助设置为帮助查看器:

**注意:**从Visual Studio 2017开始,Microsoft帮助查看器是一个可选的安装组件,因此必须通过Visual Studio安装程序额外添加。