PlusleSeedCalculator.Library.IPlugin インターフェース
これはプラスルツールのプラグイン作者向けに書かれた記事です。
プラグインの使い方を知りたい方は[id:plusletool:20100918:howtouse]を参照。
プラグインの作り方を知りたい方は[id:plusletool:20100918:PluginManual]も参照。
プラグインの本体を表すインターフェースです。
*.dllファイルの中にこのインターフェースを継承したクラスがあれば、プラグインとして扱われます。
このインターフェースを継承したクラスのインスタンス作成には、引数なしのコンストラクタを使用しています。
よって、コンストラクタが必要な場合は引数なしのコンストラクタを実装してください。
なお このコンストラクタは、ツール起動時に1度だけ呼ばれます(ツール起動から終了までの間に、1度しか呼ばれません)。
PluginName プロパティ
このプラグインの名前を取得します。
この値は、TabControlのタブ名としてツールに表示されます。
なお このプロパティは、 InitializePlugin メソッド呼び出しの後に1度だけ呼ばれます(ツール起動から終了までの間に、1度しか呼ばれません)。
【定義】
string PluginName { get; }
【プロパティ値】
このプラグインの名前。
PluginControl プロパティ
これは、TabControlの1ページとしてツールに表示されます。
なお このプロパティは、 InitializePlugin メソッド呼び出しの後に1度だけ呼ばれます(ツール起動から終了までの間に、1度しか呼ばれません)。
【定義】
UserControl PluginControl { get; }
InitializePlugin メソッド
このプラグインの初期化を行うためのメソッドです。
必要があれば、初期化はこのメソッド内で行います(iniファイル読み込みなど)。
なお このメソッドは、プラグイン作成の直後に1度だけ呼ばれます(ツール起動から終了までの間に、1度しか呼ばれません)。
【定義】
void InitializePlugin(
PlusleSeedCalculator.Library.IUtil util
);
【パラメータ】
- util
- 乱数計算やiniファイル読み書きなど、必要になりそうなメソッドを提供するクラスのインスタンス。
FinalizePlugin メソッド
このプラグインの終了準備を行うためのメソッドです。
必要があれば、このメソッドで終了準備を行います(iniファイル書き込みなど)。
なお このメソッドは、ツール終了直前に1度だけ呼ばれます(ツール起動から終了までの間に、1度しか呼ばれません)。
【定義】
void FinalizePlugin(
PlusleSeedCalculator.Library.IUtil util
);
【パラメータ】
- util
- 乱数計算やiniファイル読み書きなど、必要になりそうなメソッドを提供するクラスのインスタンス。
GetCalculator メソッド
乱数計算を実行するクラスのインスタンスを取得します。
なお このメソッドは、「検索開始」ボタンを押された時に1度だけ呼ばれます(「検索開始」ボタンを押した回数だけ呼ばれます)。
【定義】
PlusleSeedCalculator.Library.ICalculator GetCalculator();
【戻り値】
ICalculator インターフェースを継承した(自作)クラスのインスタンス。