アドイン・ファイル

関連：API テスト のみ

アドイン・ファイルには、定義するアクティビティの参照が記述されています。このファイルは XML 形式であり、アクティビティ名、依存関係、実行時 DLL などの情報が格納されています。

アドイン・ファイルは署名ファイルと一緒に、addins\CustomerAddins\＜アドイン名＞フォルダのインストール・ディレクトリに保存する必要があります。アドイン・ファイルの拡張子は .addin です。

このトピックでは、各アドイン・ファイルに含める必要があるセクションについて説明します。

Addin セクション

要素 説明
<Addin>

セクションに関する基本的な詳細。次の属性のうちのいくつかが含まれます。

  • name：アドインの名前。

  • author：アクティビティの作成者。

  • copyright：著作権情報が格納されているテキスト・ファイルの完全パス。

  • description：アクティビティの説明テキスト。

  • version：アドインのバージョン。1.0 に設定されています。
Path

アクティビティの場所に関する詳細。次の属性のうちのいくつかが含まれます。

  • name：アドインを識別する際に Framework がスキャンする論理パス。このフォルダの物理的な場所は、addins\CustomerAddins\＜アドイン名＞です。
Activity（Path 属性のサブ要素）

アクティビティに関する追加情報。次の属性のうちのいくつかが含まれます。

  • id：署名ファイルの ID に相当する文字列。

  • displayName：［ツールボックス］表示枠で表示されるアクティビティの表示名。

  • signatureFile：XML 署名ファイルの名前。

先頭に戻る

Manifest セクション

要素 説明
Identity

アドインに関する基本的な詳細。次の属性のうちのいくつかが含まれます。

  • name：署名ファイルの ID に相当するアクティビティ名。このアドインを依存関係として参照する場合にはこの名前を使用します。
Dependency

現在のアクティビティが依存するアクティビティ。次の属性のうちのいくつかが含まれます。

  • addin：依存するアクティビティの ID 名。アドイン・ファイルの Manifest セクションで指定された name 属性です。

  • requirePreload：現在のアドインをロードする前に依存関係のあるアドインをロードするかどうかを示すブール値。

先頭に戻る

Runtime セクション

要素 説明
Import

アクティビティの実行時にインポートするアセンブリ。

アセンブリの名前である assembly を使用できます。DLL 拡張子なしの DLL 名を指定します。

別のアクティビティからアドインをインポートするには、アドイン名の前にコロンを指定します。たとえば、:HP.ST.Fwk.DesignerModel により DesignerModel アドインがインポートされます。

先頭に戻る

アドイン・ファイルのサンプル

次に ReportMessageActivitySample.addin ファイルの例を示します。複数のアクティビティに一意の 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>

先頭に戻る