插件文件

相关项: API 测试

插件文件为您正在定义的活动提供引用。该文件采用 XML 格式，包含活动名称、依赖项和运行时 DLL 等信息。

插件文件应与签名文件一起位于 addins\CustomerAddins\<插件名称> 文件夹下的安装目录中。插件文件的扩展名必须是 .addin。

本主题描述每个插件文件中必须包含的部分。

Addin 部分

元素 描述
<Addin>

有关此部分的基本详细信息，包括以下任何属性:

  • name。插件的名称。

  • author。活动的创建者。

  • copyright。包含版权信息的文本文件的完整路径。

  • description。活动的文本描述。

  • version。插件文件的版本，设置为 1.0。
Path

有关活动位置的详细信息，包括以下任何属性:

  • name。框架为识别插件而扫描的逻辑路径。此文件夹的物理位置是“addins\CustomerAddins\<插件名称>”
Activity (Path 属性的子元素)

有关活动的其他信息，包括以下任何属性:

  • id。与签名文件中的 ID 对应的标识字符串。

  • displayName。活动在工具箱窗格中的显示名称。

  • signatureFile。XML 签名文件的名称。

返回页首

Manifest 部分

元素 描述
Identity

有关插件的基本详细信息，包括以下任何属性:

  • name。与签名文件中的 ID 对应的活动名称。当作为依赖项引用此插件时，使用此名称。
Dependency

当前活动所依赖的活动，包括以下任何属性:

  • addin。插件文件的清单部分的名称属性中依赖活动的身份标识名称。

  • requirePreload。指示是否在加载当前插件之前预加载依赖插件的布尔值。

返回页首

Runtime 部分

元素 描述
Import

运行活动时要导入的程序集。

您可以使用 assembly，它是程序集的名称。使用不带 DLL 扩展名的 DLL 名称。

要从其他活动导入插件，请在插件名称前面添加一个冒号。例如，:HP.ST.Fwk.DesignerModel 导入 DesignerModel 插件。

返回页首

插件文件示例

以下示例显示 ReportMessageActivitySample.addin 文件。对于多个活动，使用唯一的插件文件。


<?xml version="1.0" encoding="utf-8"?>
<AddIn name        = "HP Report Message Activity Sample"
    author      = "John Doe"
    copyright   = "C:\Copyrights\copyright.txt"
    description = "Extensibility Sample - Report Message Activity"
    version="1.0">
  <Manifest>
    <!--<Must be unique -->
    <Identity name = "ReportMessageActivitySample"/>
  </Manifest>
  <Runtime>
    <Import assembly=":HP.ST.Fwk.DesignerModel"/>
  </Runtime>
<Path name = "/ST/Activities">
    <!--Misc Activities -->
    <Activity id    = "ReportMessageActivitySample"
         displayName   = "ReportMessageSample"
         signatureFile = "ReportMessageActivitySample.xml"
         assembly="ReportMessageActivitySample.dll"/>
  </Path>  
</AddIn>

返回页首