プラグイン

Transcription

1 プラグイン プラグイン詳細 1 Adobe Photoshop や Becky! Internet Mail 等のアプリケーションでは プラグイン ( 又は アドイン エクステンション等 ) と呼ばれるプログラムをインストールする事に依り 機能を追加する事が出来る様に成って居る 此処では 此の様なプラグイン機能を持ったアプリケーションの作り方を考えて観る事にする 其れは インターフェイスを使用すると謂う方法で有る 詰り プラグインと仕て必要と成る機能をプロパティやメソッド ( 更に イベントやインデクサ ) と仕て持つインターフェイスを予め用意して置き 此のインターフェイスを実装したクラスと仕てプラグインを作成するので有る インターフェイスの作成 理屈は扨て置き 実際にプラグインを作成して観る事にする 此処で作成するプラグインは プラグインの名前を返す機能と 渡された文字列を処理して 結果を文字列と仕て返す機能を有する物とし 夫々の機能の為に Name プロパティと Run メソッドを持つインターフェイスを作る Visual Studio では クラスライブラリのプロジェクトを作成し 下記の様なコードを書き ビルドする.NET SDK の場合は /target:library コンパイラオプションに依り コードライブラリを作成する 猶 此処で作成されたアセンブリファイル名は Plugin.dll で有るとする Visual Studio の Visual Basic の場合は プロジェクトのプロパティの ルート名前空間 が空白に成って居る物とする ( デフォルトでは プロジェクト名と成って居るので プロジェクトのプロパティでルート名前空間の欄を消去する ) Imports System Visual Basic Namespace Plugin Public Interface IPlugin ReadOnly Property Name( ) As String Function Run( ByVal Str As String ) As String End Interface End Namespace C# using System; namespace Plugin public interface IPlugin string Name get; string Run( string str ); -1-

2 プラグインの作成 次に 此のインターフェイスを基に プラグインを作る プラグインもクラスライブラリと仕て作成する プラグインは今作成した IPlugin インターフェイスを実装する必要が有るので Plugin.dll を参照に追加する 具体的には Visual Studio の場合は ソリューションエクスプローラの 参照設定 に Plugin.dll を追加する.NET SDK の場合は /reference コンパイラオプションを使用する 此処では 渡された文字列の文字数を返すプラグインを作成する事にする IPlugin インターフェイスを実装した下記の様な CountChars クラスを作成する 此のクラスライブラリは CountChars.dll と謂う名前のアセンブリファイルと仕てビルドする物とする Public Class CountChars Implements Plugin.IPlugin Visual Basic ' プラグインの名前を返すプロパティ Public ReadOnly Property Name( ) As String _ Implements Plugin.IPlugin.Name Return " 文字数取得 " End ' 文字数を文字列で返すメソッド Public Function Run( ByVal Str As String ) As String _ Implements Plugin.IPlugin.Run Return Str.Length.ToString( ) End Function End Class using System; C# namespace CountChars public class CountChars : Plugin.IPlugin public string Name get return " 文字数取得 "; public string Run( string str ) return str.length.tostring( ); -2-

3 プラグインを使うアプリケーションの作成 残るはプラグインを使用するメインアプリケーションの作成で有る メインアプリケーションでは インストールされて居る有効なプラグインを何の様に探すか 然して プラグインクラスのインスタンスを何の様に作成するかと謂う事が問題と成る 先ず インストールされて居るプラグインを探す方法に付いてで有る プラグインは 必ず dll と謂う拡張子を持ち 指定されたフォルダに置かれて居なければ成らないと謂う約束に仕て置く ( 此処では メインアプリケーションがインストールされて居るフォルダに有る plugins フォルダにプラグインを置く物とする ) 此れに依り メインアプリケーションは プラグインフォルダに有る dll の拡張子を持つファイル而巳を調べれば良い事に成る 更に アセンブリに IPlugin インターフェイスを実装したクラスが有るか調べるには リフレクションを使用する 亦 プラグインクラスのインスタンスを作成するには Activator.CreateInstance メソッド等を使用すれば良い ( 下記のサンプルでは Assembly.CreateInstance メソッドを使用して居る ) 其れでは 実際に作成して観る事にする 此処では メインアプリは コンソールアプリケーションと仕て作成する事にする 亦 Plugin.dll を参照に追加する 先ずは プラグインを扱うクラス (PluginInfo) を作成する 此のクラスは プラグインのアセンブリファイルのパスとクラス名を返すプロパティ ( 夫々 Location と ClassName) と 有効なプラグインを探すメソッド (FindPlugins) IPlugin のインスタンスを作成するメソッド (CreateInstance) を有する 此のクラスのコードを以下に示す Public Class PluginInfo Private LocationValue As String Private ClassNameValue As String Visual Basic ' PluginInfo クラスのコンストラクタ Private Sub New( ByVal path As String, ByVal cls As String ) Me.LocationValue = path Me.ClassNameValue = cls End Sub ' アセンブリファイルのパス Public ReadOnly Property Location( ) As String Return LocationValue End ' クラスの名前 Public ReadOnly Property ClassName( ) As String Return ClassNameValue End ' 有効なプラグインの探索するメソッド Public Shared Function FindPlugins( ) As PluginInfo( ) Dim Plugins As New System.Collections.ArrayList -3-

4 ' IPlugin 型の名前 Dim PluginName As String = Type( Plugin.IPlugin ).FullName ' プラグインフォルダ Dim Folder As String = _ System.IO.Path.DirectoryName( _ System.Reflection.Assembly. _ ExecutingAssembly( ).Location ) If Not Folder.EndsWith( " " ) Then Folder &= " " Folder &= "plugins" If Not System.IO.Directory.Exists( Folder ) Then Throw New ApplicationException( _ " プラグインフォルダ " & Folder & " が見付かりませんでした ") End If ' DLL ファイルの探索 Dim dlls As String( ) = System.IO.Directory.Files( Folder, "*.dll" ) Dim Dll As String For Each Dll In dlls Try ' アセンブリと仕て読込 Dim Asm As System.Reflection.Assembly = System.Reflection.Assembly.LoadFrom( Dll ) Dim T As Type For Each T In Asm.Types( ) ' アセンブリ内の総ての型に付いてプラグインと仕て有効か調査 If T.IsClass AndAlso T.IsPublic AndAlso _ Not T.IsAbstract AndAlso _ Not ( T.Interface( PluginName ) Is Nothing ) Then ' PluginInfo をコレクションに追加 Plugins.Add( New PluginInfo( Dll, T.FullName )) End If Next Catch End Try Next ' コレクションを配列に仕て復帰 Return CType( Plugins.ToArray( Type( PluginInfo )), PluginInfo( )) End Function ' プラグインクラスのインスタンスを作成するメソッド Public Function CreateInstance( ) As Plugin.IPlugin Try ' アセンブリの読込 Dim Asm As System.Reflection.Assembly = _ System.Reflection.Assembly.LoadFrom( Me.Location ) ' クラス名からインスタンスを作成 Return CType( Asm.CreateInstance( Me.ClassName ), Plugin.IPlugin ) Catch End Try Return Nothing End Function End Class -4-

5 using System; C# namespace Plugin // プラグインに関する情報 public class PluginInfo private string _location; private string _classname; // PluginInfo クラスのコンストラクタ // 引数は path: アセンブリファイルのパス cls: クラスの名前 private PluginInfo( string path, string cls ) this.location = path; this.classname = cls; // アセンブリファイルのパス public string Location get return _location; // クラスの名前 public string ClassName get return _classname; // 有効なプラグインを探す ( 戻り値は 有効なプラグインの PluginInfo 配列 ) public static PluginInfo[ ] FindPlugins( ) System.Collections.ArrayList plugins = new System.Collections.ArrayList( ); // IPlugin 型の名前 string ipluginname = typeof( Plugin.IPlugin ).FullName; // プラグインフォルダ string folder = System.IO.Path.DirectoryName( System.Reflection.Assembly.ExecutingAssembly( ).Location ); folder += " plugins"; if (!System.IO.Directory.Exists( folder )) throw new ApplicationException( folder + " が見付かりませんでした "); //.dll ファイルを探す string[ ] dlls = System.IO.Directory.Files( folder, "*.dll" ); foreach ( string dll in dlls ) try // アセンブリと仕て読み込む -5-

6 System.Reflection.Assembly asm = System.Reflection.Assembly.LoadFrom( dll ); foreach (Type t in asm.types( )) // アセンブリ内の総ての型に付いて プラグインと仕て有効か調べる if ( t.isclass && t.ispublic &&!t.isabstract && t.interface( ipluginname )!= null ) // PluginInfo をコレクションに追加する plugins.add( new PluginInfo( dll, t.fullname )); catch // コレクションを配列にして返す return ( PluginInfo[ ]) plugins.toarray( typeof( PluginInfo )); // プラグインクラスのインスタンスを作成する ( 戻り値は プラグインクラスのインスタンス ) public Plugin.IPlugin CreateInstance( ) try // アセンブリを読み込む System.Reflection.Assembly asm = System.Reflection.Assembly.LoadFrom( this.location ); // クラス名からインスタンスを作成する return ( Plugin.IPlugin ) asm.createinstance( this.classname ); catch return null; FindPlugins メソッドが多少複雑なので 簡単に説明して置く FindPlugins メソッドでは Assembly.LoadFrom メソッドでアセンブリを読み込んだ後 アセンブリ内の総ての型に付いて 其の型がクラスで有り パブリックで有り 抽象クラスで無い事を確認し 更に Type.Interface メソッドに依り IPlugin インターフェイスを実装して居る事を確認する 此等総ての条件に当て嵌る場合に有効なプラグインと判断する ( 拠って 此の例では 1 つのアセンブリファイルに複数のプラグインクラスを定義する事が出来る ) 此処迄来れば 後は簡単で有る PluginInfo クラスを使ったメインのクラス ( エントリポイント ) のサンプルは 下記の様に成る 猶 下記は コンソールアプリケーションと仕て作成し 実行ファイルの在るフォルダ ( 編集時には bin/debug フォルダ ) 直下に plugins と謂う名前のフォルダが在り 其の中にプラグインファイル ( 前述の CountChars.dll 等 ) が在る物とする 亦 前述の Plugin.dll と PluginInfo.dll の参照が追加されて居る物とする -6-

7 Imports System Visual Basic Module PluginHost < STAThread( )> _ Public Sub Main( ) Dim Pis( ) As PluginInfo.PluginInfo = PluginInfo.PluginInfo.FindPlugins( ) ' 総てのプラグインクラスのインスタンスを作成する Dim Plugins( Pis.Length - 1 ) As Plugin.IPlugin For I As Integer = 0 To ( Plugins.Length - 1 ) Plugins( I ) = Pis( I ).CreateInstance( ) Next ' 有効なプラグインを表示し 使用するプラグインを選ばせる Dim Number As Integer = -1 Do For I As Integer = 0 To ( Plugins.Length - 1 ) Console.WriteLine( "0:1", I, Plugins( I ).Name ) Next Console.WriteLine( " 使用するプラグインの番号を入力して下さい :" ) Try Number = Integer.Parse( Console.ReadLine( )) Catch End Try Loop While Number < 0 OrElse Number >= Pis.Length Console.WriteLine( Plugins( Number ).Name + " を使用する " ) ' プラグインに渡す文字列の入力を促す Console.WriteLine( " 文字列を入力して下さい :" ) Dim S As String = Console.ReadLine( ) ' プラグインの Run メソッドを呼び出して結果を取得する Dim R As String = Plugins( Number ).Run( S ) ' 結果の表示 Console.WriteLine( " 結果 :" ) Console.WriteLine( R ) Console.ReadLine( ) End Sub End Module using System; C# namespace MainApplication public class PluginHost [ STAThread ] static void Main( string[ ] args ) -7-

8 // インストールされて居るプラグインを調べる PluginInfo[ ] pis = Plugin.PluginInfo.FindPlugins( ); // 総てのプラグインクラスのインスタンスを作成する Plugin.IPlugin[ ] plugins = new Plugin.IPlugin[ pis.length ]; for ( int i = 0; i < plugins.length; i++ ) plugins[ i ] = pis[ i ].CreateInstance( ); // 有効なプラグインを表示し 使用するプラグインを選ばせる int number = -1; do for ( int i = 0; i < plugins.length; i++ ) Console.WriteLine( "0:1", i, plugins[ i ].Name ); Console.WriteLine( " 使用するプラグインの番号を入力して下さい :" ); try number = int.parse( Console.ReadLine( )); catch Console.WriteLine( " 数字を入力して下さい " ); while ( number < 0 number >= pis.length ); Console.WriteLine( plugins[ number ].Name + " を使用する " ); // プラグインに渡す文字列の入力を促す Console.WriteLine( " 文字列を入力して下さい :" ); string str = Console.ReadLine( ); // プラグインの Run メソッドを呼び出して結果を取得する string result = plugins[ number ].Run( str ); // 結果の表示 Console.WriteLine( " 結果 :" ); Console.WriteLine( result ); Console.ReadLine( ); 前述の通り メインアプリ実行前に実行ファイルの有るフォルダに plugins と謂うフォルダを作り 其処に先程作成した CountChars.dll をコピーして置く 此れで CountChars.dll をプラグインと仕て認識出来る 色々なプラグインを作成し plugins フォルダに格納して プラグインを選択する事が出来る様に仕て 動作確認して欲しい 基本的なプラグイン機能の実現方法は以上で有る 併し より高度なプラグイン機能が必要な場合には 此れ丈では不十分かも知れない 例えば プラグインからメインアプリにフィードバックし度い等 プラグインからメインアプリケーションの機能 ( メソッド ) を呼び出し度いケースも有る 其の様な場合には プラグインを使う側で実装するインターフェイスを定義すると謂う方法が有る 続いては Windows アプリケーションのサンプルと仕て 此の方法を紹介する -8-

9 Windows アプリケーションでプラグイン機能を実現する 此処からは更に実用的な例と仕て Windows アプリケーションでプラグイン機能を実現する方法を紹介する 此処では 具体的に プラグインの使用出来る簡単なエディタを作成する事にする 飽く迄 プラグイン機能を説明する事が目的なので エディタは思い切り単純にし フォームに RichTextBox と MainMenu 而巳を配置する事にする プラグインからエディタの RichTextBox コントロールにアクセスする事に依り プラグインの機能が果たせる様にする インターフェイスを定義する 前回と同じ様に 先ずプラグインのクラスが実装す可きインターフェイスを定義する 今回はプラグインのインターフェイスに加えて プラグインを使用するホストの側が実装す可きインターフェイスも定義する事にする ホストの為のインターフェイスでは プラグインのホストと仕て必要な機能をメンバと仕て定義し プラグインから此のメンバを通してホストにアクセス出来る様にする 具体的には プラグインから指定されたメッセージをホストで表示する為のメソッドと ホストの RichTextBox コントロールを取得する為のプロパティ 更にホストのメインフォームを取得する為のプロパティを定義する事にする 其れでは 実際に此等のインターフェイスを作成する事にする 前回と同様 クラスライブラリと仕て作成する為 Visual Studio ではクラスライブラリのプロジェクトを作成し (Plugin と謂う名前で作成して居る ).NET SDK では /target:library コンパイラオプションを使用する 亦 アセンブリファイル名は Plugin.dll とする 更に今回は Windows アプリケーションを扱う為 System.Windows.Forms.dll を参照に追加する ( 参照に追加するには Visual Studio.NET の場合は ソリューションエクスプローラの 参照設定 を.NET SDK の場合は /reference コンパイラオプションを使用する ) コードは 下記の様に成る IPlugin インターフェイスがプラグインの為のインターフェイスで IPluginHost インターフェイスがプラグインのホストの為のインターフェイスで有る Imports System Imports System.Windows.Forms Visual Basic Namespace Plugin ' プラグインで実装するインターフェイス Public Interface IPlugin ' プラグインの名前 ReadOnly Property Name( ) As String ' プラグインのバージョン ReadOnly Property Version( ) As String ' プラグインの説明 ReadOnly Property Description( ) As String ' プラグインのホスト Property Host( ) As IPluginHost ' プラグインを実行する Sub Run( ) End Interface -9-

10 ' プラグインのホストで実装するインターフェイス Public Interface IPluginHost ' ホストのメインフォーム ReadOnly Property MainForm( ) As Form ' ホストの RichTextBox コントロール ReadOnly Property RichTextBox( ) As RichTextBox ' ホストでメッセージを表示する ' 引数は Plugin: メソッドを呼び出すプラグイン Msg: 表示するメッセージ Sub ShowMessage( ByVal Plugin As IPlugin, ByVal Msg As String ) End Interface End Namespace C# using System; using System.Windows.Forms; namespace Plugin // プラグインで実装するインターフェイス public interface IPlugin // プラグインの名前 string Name get; // プラグインのバージョン string Version get; // プラグインの説明 string Description get; // プラグインのホスト IPluginHost Host get; set; // プラグインを実行する void Run( ); // プラグインのホストで実装するインターフェイス public interface IPluginHost // ホストのメインフォーム Form MainForm get; // ホストの RichTextBox コントロール RichTextBox RichTextBox get; // ホストでメッセージを表示する // 引数は plugin: メソッドを呼び出すプラグイン msg: 表示するメッセージ void ShowMessage( IPlugin plugin, string msg ); -10-

11 IPlugin は 前回と比べ プラグインのバージョンと説明を取得する為のプロパティが新たに追加され 更に Run メソッドもパラメータ 戻り値が無く成った 亦 IPluginHost を設定 取得する為のプロパティも加えられて居る プラグインを作成する 次に IPlugin インターフェイスを実装したプラグインのクラスを作成する 此処では RichTextBox 内の文字数を表示するプラグイン (CountChars クラス ) を作成して観る事にする プラグインも前回と同様に クラスライブラリと仕て作成し Plugin.dll を参照に追加する 亦 System.Windows.Forms.dll も参照に追加する 出力するアセンブリファイル名は CountChars.dll とする (Visual Studio.NET の Visual Basic の場合は プロジェクトのプロパティの ルート名前空間 が空白に成って居る物とする デフォルトではプロジェクト名と成って居るので 変更する必要が有る ) CountChars クラスのコードは下記の様に成る Imports System Visual Basic Public Class CountChars Implements Plugin.IPlugin Private _host As Plugin.IPluginHost ' IPlugin のプロパティメンバ ( プラグインの名前 ) Public ReadOnly Property Name( ) As String Implements Plugin.IPlugin.Name Return " 文字数取得 " End ' IPlugin のプロパティメンバ ( プラグインのバージョン ) Public ReadOnly Property Version( ) As String Implements Plugin.IPlugin.Version ' 自分自身の Assembly を取得し バージョンを返す Dim Asm As System.Reflection.Assembly = _ System.Reflection.Assembly.ExecutingAssembly( ) Dim Ver As System.Version = Asm.Name( ).Version Return Ver.ToString( ) End ' IPlugin のプロパティメンバ ( プラグインの説明 ) Public ReadOnly Property Description( ) As String Implements Plugin.IPlugin.Description Return " エディタで編集中の文章の文字数を表示する " End ' IPlugin のプロパティメンバ ( プラグインのホスト ) Public Property Host( ) As Plugin.IPluginHost Implements Plugin.IPlugin.Host -11-

12 Return Me._host End Set( ByVal value As Plugin.IPluginHost ) Me._host = value End Set ' IPlugin のメソッドメンバ (RichTextBox の文字数を表示する ) Public Sub Run( ) Implements Plugin.IPlugin.Run Dim Msg As String = String.Format( " 文字数 : 0 文字 ", _ Me._host.RichTextBox.Text.Length ) Me._host.ShowMessage( Me, Msg ) End Sub End Class C# using System; namespace CountChars // 文字数を表示する為のプラグイン public class CountChars : Plugin.IPlugin private Plugin.IPluginHost _host; // IPlugin のプロパティメンバ ( プラグインの名前 ) public string Name get return " 文字数取得 "; // IPlugin のプロパティメンバ ( プラグインのバージョン ) public string Version get // 自分自身の Assembly を取得し バージョンを返す System.Reflection.Assembly asm = System.Reflection.Assembly.ExecutingAssembly( ); System.Version ver = asm.name( ).Version; return ver.tostring( ); // IPlugin のプロパティメンバ ( プラグインの説明 ) public string Description get return " エディタで編集中の文章の文字数を表示する "; // IPlugin のプロパティメンバ ( プラグインのホスト ) public Plugin.IPluginHost Host -12-

13 get return this._host; set this._host = value; // IPlugin のメソッドメンバ (RichTextBox の文字数を表示する ) public void Run( ) string msg = string.format( " 文字数 : 0 文字 ", this._host.richtextbox.text.length ); this._host.showmessage( this, msg ); 特に説明を要さないと思う Run メソッドでは IPluginHost オブジェクトから RichTextBox にアクセスし 文字数を取得し IPluginHost の ShowMessage メソッドで結果をホストで表示して居る ウィンドウを表示するプラグインの作成 次に Windows アプリケーションらしく ウィンドウを表示するプラグインを作成して観る事にする 此処では 検索 ウィンドウに依り RichTextBox から指定された文字列を検索するプラグインを作る ( エディタと仕ては プラグインで処理する機能では無いが ) 先ず CountChars クラスと同様 クラスライブラリのプロジェクトを作成し ( 名前は FindString とする ) Plugin.dll と System.Windows.Forms.dll を参照に追加する (System.Windows.Forms.dll は今追加しなくても Windows フォームの追加 でプロジェクトにフォームを追加すれば 自動的に追加される ) 続いて Windows フォームの追加 でプロジェクトにフォーム (FindForm) を追加し 検索 ウィンドウを作成する 此のフォームに配置するコントロール 及び 変更するプロパティ ( 或いは イベント ) の一覧は下記の様に成る コントロールの種類 プロパティ プロパティの設定値 フォーム Name FindForm Text 検索 AcceptButton btnfind CancelButton btnclose FormBorderStyle FixedToolWindow ShowInTaskbar false テキストボックス Name txtfindstring Text 空白 ボタン1 Name btnfind Text 次を検索 DialogResult OK Click イベント btnfind_click -13-

14 ボタン2 Name btnclose Text 閉じる DialogResult Cancel Click イベント btnclose_click チェックボックス1 Name chkwholeword Text 単語単位で検索する チェックボックス2 Name chkmatchcase Text 大文字小文字を区別する チェックボックス3 Name chkreverse Text 上へ検索する 更に FindForm クラスに下記のコードを追加し 指定された RichTextBox を検索出来る様にする Imports System.Windows.Forms Visual Basic Public Class FindForm ' 検索するリッチテキストボックス Friend RTB As RichTextBox ' ボタン ( 次を検索 ) がクリックされた時の処理 Private Sub btnfind_click( ByVal sender As System.Object, ByVal e As System.EventArgs ) _ Handles btnfind.click ' 検索オプションの決定 Dim Finds As RichTextBoxFinds = RichTextBoxFinds.None If chkwholeword.checked Then Finds = Finds Or RichTextBoxFinds.WholeWord End If If chkmatchcase.checked Then Finds = Finds Or RichTextBoxFinds.MatchCase End If If chkreverse.checked Then Finds = Finds Or RichTextBoxFinds.Reverse End If ' 検索範囲の決定 Dim StartPos, EndPos As Integer If Not chkreverse.checked Then StartPos = Me.RTB.SelectionStart + Me.RTB.SelectionLength EndPos = -1 If StartPos >= Me.RTB.TextLength Then MessageBox.Show( " 検索が完了しました ", " 検索 " ) Return End If Else StartPos = 0 EndPos = Me.RTB.SelectionStart If EndPos <= 0 Then MessageBox.Show( " 検索が完了しました ", " 検索 " ) Return End If End If -14-

15 ' 検索 If Me.RTB.Find( txtfindstring.text, StartPos, EndPos, Finds ) < 0 Then MessageBox.Show( " 検索が完了しました ", " 検索 " ) Else Me.RTB.Focus( ) End If End Sub ' ボタン ( 閉じる ) がクリックされた時の処理 Private Sub btnclose_click( ByVal sender As System.Object, ByVal e As System.EventArgs ) _ Handles btnclose.click Me.Close( ) End Sub End Class C# // 下記は Class ブロック而巳を記述 // using System.Windows.Forms; がソースファイルの一番上に書かれて居る物とする // 検索するリッチテキストボックス internal RichTextBox RichTextBox; // ボタン ( 次を検索 ) がクリックされた時の処理 private void btnfind_click( object sender, System.EventArgs e ) // 検索オプションの決定 RichTextBoxFinds finds = RichTextBoxFinds.None; if ( this.wholeword.checked ) finds = RichTextBoxFinds.WholeWord; if ( this.matchcase.checked ) finds = RichTextBoxFinds.MatchCase; if ( this.reverse.checked ) finds = RichTextBoxFinds.Reverse; // 検索範囲の決定 int startpos, endpos; if (!this.reverse.checked ) startpos = this.rtb.selectionstart + this.rtb.selectionlength; endpos = -1; if ( startpos >= this.rtb.textlength ) MessageBox.Show( " 検索が完了しました ", " 検索 " ); return; else startpos = 0; endpos = this.rtb.selectionstart; if ( endpos <= 0 ) MessageBox.Show( " 検索が完了しました ", " 検索 " ); return; // 検索 -15-

16 if ( this.rtb.find( findstring.text, startpos, endpos, finds ) < 0 ) MessageBox.Show( " 検索が完了しました ", " 検索 " ); else this.rtb.focus( ); // ボタン ( 閉じる ) がクリックされた時の処理 private void btnclose_click( object sender, System.EventArgs e ) this.close( ); 次に 此のフォームを表示させるプラグインクラス (FindString) を作成する コードは 下記の様に成る Imports System Imports System.Windows.Forms Visual Basic Public Class FindString Implements Plugin.IPlugin Private Hst As Plugin.IPluginHost Private Frm As FindForm ' IPlugin のプロパティメンバ ( プラグインの名前 ) Public ReadOnly Property Name( ) As String Implements Plugin.IPlugin.Name Return " 文字列の検索 " End ' IPlugin のプロパティメンバ ( プラグインのバージョン ) Public ReadOnly Property Version( ) As String Implements Plugin.IPlugin.Version ' 自分自身の Assembly を取得し バージョンを返す Dim Asm As System.Reflection.Assembly = _ System.Reflection.Assembly.ExecutingAssembly( ) Dim Ver As System.Version = Asm.Name( ).Version Return Ver.ToString( ) End ' IPlugin のプロパティメンバ ( プラグインの説明 ) Public ReadOnly Property Description( ) As String Implements Plugin.IPlugin.Description Return " 編集中の文章から指定された文字列を検索する " End ' IPlugin のプロパティメンバ ( プラグインのホスト ) Public Property Host( ) As Plugin.IPluginHost Implements Plugin.IPlugin.Host Return Hst -16-

17 End Set( ByVal value As Plugin.IPluginHost ) Hst = value End Set ' IPlugin のメソッドメンバ (RichTextBox の文字数を表示する ) Public Sub Run( ) Implements Plugin.IPlugin.Run ' フォームが表示されて居ればアクティブにして終了 If Not ( Me.Frm Is Nothing ) AndAlso _ Not Me.Frm.IsDisposed Then Me.Frm.Activate( ) Return End If ' 検索ウィンドウを作成して表示 Me.Frm = New FindForm Me.Frm.RTB = Me.Hst.RichTextBox Me.Frm.Owner = Me.Hst.MainForm Me.Frm.Show( ) End Sub End Class using System; using System.Windows.Forms; C# namespace FindString public class FindString : Plugin.IPlugin private Plugin.IPluginHost _host; private FindForm _mainform; // IPlugin のプロパティメンバ ( プラグインの名前 ) public string Name get return " 文字列の検索 "; // IPlugin のプロパティメンバ ( プラグインのバージョン ) public string Version get // 自分自身の Assembly を取得し バージョンを返す System.Reflection.Assembly asm = System.Reflection.Assembly.ExecutingAssembly( ); System.Version ver = asm.name( ).Version; return ver.tostring( ); // IPlugin のプロパティメンバ ( プラグインの説明 ) -17-

18 public string Description get return " 編集中の文章から指定された文字列を検索する "; // IPlugin のプロパティメンバ ( プラグインのホスト ) public Plugin.IPluginHost Host get return _host; set _host = value; // IPlugin のメソッドメンバ (RichTextBox の文字数を表示する ) public void Run( ) // フォームが表示されて居ればアクティブにして終了 if ( this._mainform!= null &&!this._mainform.isdisposed ) this._mainform.activate( ); return; // 検索ウィンドウを作成して表示 this._mainform = new FindForm( ); this._mainform.richtextbox = this._host.richtextbox; this._mainform.owner = this._host.mainform; this._mainform.show( ); Run メソッドで FindForm を表示して居る丈で 特に問題は無いと思う ( 表示する前に RichTextBox の設定と オーナーウィンドウの設定を行って居る ) メインアプリケーションの作成 愈々 プラグインを使用するホストのアプリケーションを作成する事にする ホストアプリケーションは Windows アプリケーションプロジェクトと仕て作成し ( 名前は MainApplication とする ) Plugin.dll を参照に追加する フォームには RichTextBox と メニュー 更に メッセージを表示する為の StatusBar コントロールを配置する 変更するフォームのプロパティと フォームに配置するコントロールと其のプロパティ ( 然して イベント ) の一覧を下記に示す 此処から -18-

19 コントロールの種類 プロパティ プロパティの設定値 フォーム Name Form1 Menu mainmenu Load イベント Form1_Load リッチテキストボックス Name mainrichtextbox Dock Fill ステータスバー Name mainstatusbar メインメニュー Name mainmenu メニューアイテム1 Name menuplugins Text プラグイン (&P) Click イベント menuplugin_click メニューアイテム2 Name menuhelp Text ヘルプ (&H) メニューアイテム3 Name menuabout Text バージョン情報 (&A)... Click イベント menuabout_click 次に前回で作成した PluginInfo クラスをプロジェクトに追加する 但し CreateInstance メソッドで IPluginHost オブジェクトを IPluginHost.Host プロパティに設定する様に変更して居る PluginInfo クラスは下記の様なコードで有る Imports System Visual Basic ' プラグインに関する情報 Public Class PluginInfo Private _location As String Private _classname As String ' PluginInfo クラスのコンストラクタ ' 引数は path: アセンブリファイルのパス cls: クラスの名前 Private Sub New(ByVal path As String, ByVal cls As String) Me._location = path Me._className = cls End Sub ' アセンブリファイルのパス Public ReadOnly Property Location() As String Return _location End ' クラスの名前 Public ReadOnly Property ClassName() As String Return _classname End -19-

20 ' 有効なプラグインを探す ( 戻り値は 有効なプラグインの PluginInfo 配列 ) Public Shared Function FindPlugins() As PluginInfo() Dim plugins As New System.Collections.ArrayList 'IPlugin 型の名前 Dim ipluginname As String = _ Type(Plugin.IPlugin).FullName ' プラグインフォルダ Dim folder As String = _ System.IO.Path.DirectoryName( _ System.Reflection.Assembly. _ ExecutingAssembly().Location) folder += " plugins" If Not System.IO.Directory.Exists(folder) Then Throw New ApplicationException( _ " プラグインフォルダ """ + folder + _ """ が見付かりませんでした ") End If '.dll ファイルを探す Dim dlls As String() = _ System.IO.Directory.Files(folder, "*.dll") Dim dll As String For Each dll In dlls Try ' アセンブリと仕て読み込む Dim asm As System.Reflection.Assembly = _ System.Reflection.Assembly.LoadFrom(dll) Dim t As Type For Each t In asm.types() ' アセンブリ内の総ての型に付いて ' プラグインと仕て有効か調べる If t.isclass And t.ispublic And _ Not t.isabstract And _ Not (t.interface(ipluginname) Is Nothing _ ) Then 'PluginInfo をコレクションに追加する plugins.add(new PluginInfo(dll, t.fullname)) End If Next t Catch End Try Next dll ' コレクションを配列にして返す Return CType(plugins.ToArray( _ Type(PluginInfo)), PluginInfo()) End Function 'FindPlugins ' プラグインクラスのインスタンスを作成する ( 戻り値は プラグインクラスのインスタンス ) Public Function CreateInstance( _ ByVal host As Plugin.IPluginHost) As Plugin.IPlugin Try -20-

21 ' アセンブリを読み込む Dim asm As System.Reflection.Assembly = _ System.Reflection.Assembly.LoadFrom(Me.Location) ' クラス名からインスタンスを作成する Dim plugin As Plugin.IPlugin = _ CType(asm.CreateInstance(Me.ClassName), _ Plugin.IPlugin) 'IPluginHost の設定 plugin.host = host Return plugin Catch End Try End Function End Class C# using System; namespace MainApplication // プラグインに関する情報 public class PluginInfo private string _location; private string _classname; // PluginInfo クラスのコンストラクタ // 引数は path: アセンブリファイルのパス cls: クラスの名前 private PluginInfo(string path, string cls) this._location = path; this._classname = cls; // アセンブリファイルのパス public string Location get return _location; // クラスの名前 public string ClassName get return _classname; // 有効なプラグインを探す ( 戻り値は 有効なプラグインの PluginInfo 配列 ) public static PluginInfo[] FindPlugins() System.Collections.ArrayList plugins = new System.Collections.ArrayList(); //IPlugin 型の名前 string ipluginname = typeof(plugin.iplugin).fullname; // プラグインフォルダ -21-

22 string folder = System.IO.Path.DirectoryName( System.Reflection.Assembly.ExecutingAssembly().Location); folder += " plugins"; if (!System.IO.Directory.Exists(folder)) throw new ApplicationException( " プラグインフォルダ "" + folder + " " が見付かりませんでした "); //.dll ファイルを探す string[] dlls = System.IO.Directory.Files(folder, "*.dll"); foreach (string dll in dlls) try // アセンブリと仕て読み込む System.Reflection.Assembly asm = System.Reflection.Assembly.LoadFrom(dll); foreach (Type t in asm.types()) // アセンブリ内の総ての型に付いて // プラグインと仕て有効か調べる if (t.isclass && t.ispublic &&!t.isabstract && t.interface(ipluginname)!= null) //PluginInfo をコレクションに追加する plugins.add( new PluginInfo(dll, t.fullname)); catch // コレクションを配列にして返す return (PluginInfo[]) plugins.toarray(typeof(plugininfo)); // プラグインクラスのインスタンスを作成する ( 戻り値は プラグインクラスのインスタンス ) public Plugin.IPlugin CreateInstance(Plugin.IPluginHost host) try // アセンブリを読み込む System.Reflection.Assembly asm = System.Reflection.Assembly.LoadFrom(this.Location); // クラス名からインスタンスを作成する Plugin.IPlugin plugin = (Plugin.IPlugin) asm.createinstance(this.classname); //IPluginHost の設定 -22-

23 plugin.host = host; return plugin; catch return null; IPluginHost インターフェイスは フォームクラスで実装する 亦 プラグインの読込と メニューへの表示はフォームの Load イベントハンドラで行い メニューを選択する事に依り プラグインを実行出来る様にする 下記に変更を加えたフォームクラスの主要部分のコード (Windows フォームデザイナが作成したコードを除く ) を示す Visual Basic Public Class Form1 Inherits System.Windows.Forms.Form Implements Plugin.IPluginHost '( 省略 ) 'IPlugin の配列 Dim plugins() As Plugin.IPlugin 'IPluginHost の実装 Public ReadOnly Property MainForm() As Form _ Implements Plugin.IPluginHost.MainForm Return Me End Public ReadOnly Property RichTextBox() As RichTextBox _ Implements Plugin.IPluginHost.RichTextBox Return mainrichtextbox End Public Sub ShowMessage(ByVal plugin As Plugin.IPlugin, _ ByVal msg As String) _ Implements Plugin.IPluginHost.ShowMessage ' ステータスバーに表示する mainstatusbar.text = msg End Sub ' メインフォームの Load イベントハンドラ Private Sub Form1_Load(ByVal sender As Object, _ ByVal e As System.EventArgs) Handles MyBase.Load ' インストールされて居るプラグインを探す -23-

24 Dim pis As PluginInfo() = PluginInfo.FindPlugins() ' プラグインのインスタンスを取得する Me.plugins = New Plugin.IPlugin(pis.Length - 1) Dim i As Integer For i = 0 To (Me.plugins.Length) - 1 Me.plugins(i) = pis(i).createinstance(me) Next i ' プラグインを実行するメニューを追加する Dim plugin As Plugin.IPlugin For Each plugin In Me.plugins Dim mi As New MenuItem(plugin.Name, _ AddressOf menuplugin_click) Me.menuPlugins.MenuItems.Add(mi) Next plugin End Sub ' プラグインのメニューがクリックされた時 Private Sub menuplugin_click(byval sender As Object, _ ByVal e As System.EventArgs) Handles menuplugins.click Dim mi As MenuItem = CType(sender, MenuItem) ' クリックされたプラグインを探す '( 同じ名前のプラグインが複数有ると困った事に...) Dim plugin As Plugin.IPlugin For Each plugin In Me.plugins If mi.text = plugin.name Then ' クリックされたプラグインを実行する plugin.run() Return End If Next plugin End Sub ' プラグインのバージョンを表示する Private Sub menuabout_click(byval sender As Object, _ ByVal e As System.EventArgs) Handles menuabout.click Dim msg As String = " インストールされて居るプラグイン " + vblf _ + "( 名前 : 説明 : バージョン )" + vblf + vblf Dim plugin As Plugin.IPlugin For Each plugin In Me.plugins msg += String.Format("0 : 1 : 2" + vblf, _ plugin.name, plugin.description, plugin.version) Next plugin MessageBox.Show(msg) End Sub End Class C# namespace MainApplication public class Form1 : System.Windows.Forms.Form, Plugin.IPluginHost //( 省略 ) -24-

25 //IPlugin の配列 Plugin.IPlugin[] plugins; //IPluginHost の実装 public Form MainForm get return (Form) this; public RichTextBox RichTextBox get return mainrichtextbox; public void ShowMessage(Plugin.IPlugin plugin, string msg) // ステータスバーに表示する mainstatusbar.text = msg; // メインフォームの Load イベントハンドラ private void Form1_Load(object sender, System.EventArgs e) // インストールされて居るプラグインを探す PluginInfo[] pis = PluginInfo.FindPlugins(); // プラグインのインスタンスを取得する this.plugins = new Plugin.IPlugin[pis.Length]; for (int i = 0; i < this.plugins.length; i++) this.plugins[i] = pis[i].createinstance(this); // プラグインを実行するメニューを追加する foreach (Plugin.IPlugin plugin in this.plugins) MenuItem mi = new MenuItem(plugin.Name, new EventHandler(menuPlugin_Click)); this.menuplugins.menuitems.add(mi); // プラグインのメニューがクリックされた時 private void menuplugin_click( object sender, System.EventArgs e) MenuItem mi = (MenuItem) sender; // クリックされたプラグインを探す //( 同じ名前のプラグインが複数有ると困った事に...) foreach (Plugin.IPlugin plugin in this.plugins) if (mi.text == plugin.name) -25-

26 // クリックされたプラグインを実行する plugin.run(); return; // プラグインのバージョンを表示する private void menuabout_click( object sender, System.EventArgs e) string msg = " インストールされて居るプラグイン n" + "( 名前 : 説明 : バージョン ) n n"; foreach (Plugin.IPlugin plugin in this.plugins) msg += string.format("0 : 1 : 2 n", plugin.name, plugin.description, plugin.version); MessageBox.Show(msg); 此のメインアプリケーションを実行させるには 実行ファイルの有るフォルダに plugins と謂うフォルダを作り 其処に前に作成したプラグイン CountChars.dll と FindString.dll をコピーする 旨く行くと プラグイン メニューに 文字数取得 と 文字列の検索 が追加され プラグインの機能を呼び出す事が出来る様に成る 以上でプラグイン機能を実現させる方法に関する解説は終了で有る 此処で紹介した知識を応用する事に依り より複雑なプラグインも作成出来ると思う -26-