-
VB.NET-Tipsではないのですが、この記事から Visual Basic 繋がりで、VBA(Visual Basic for Applications)についても番外的な記事として 載せていこうと思います。
access vba でWordを起動しWordファイルを読込んだ後で、ファイルを保存する時に読込みファイル名に日付と時刻を自動で 付加する必要が在ったので、できるのか調べてみました。
Wordのメニューから「名前を付けて保存」や「上書き保存」などを選択した時に、 DocumentBeforeSave のイベントが発生することは分かったのですが、 これの例としては、以下の様に保存の前の確認を行うものしかありませんでした。
どうすればこのタイミングでファイル名を変更できるのかが知りたいことでしたが、 調べ方が悪いのかネットには例がありませんでした。DocumentBeforeSave を使った簡単な例
Private Sub WordApp_DocumentBeforeSave(ByVal Doc As Word.Document, SaveAsUI As Boolean, Cancel As Boolean) Dim intRet As Integer intRet = MsgBox("ドキュメントを保存しますか?", vbYesNo) If intRet = vbNo Then Cancel = True End If End Sub
この例では、Wordでのファイル書き込み時に DocumentBeforeSave のイベントでファイル名を変更してやれば 出来るようなかんじでした。 しかし、ことはそんなに簡単ではなく、 DocumentBeforeSave のイベントの引数内の Doc ですが この中のプロパティで name が在ったのでこれを変更すればと思ったのですが、 これは Readonly のプロパティで変更できない様です。
ならば、 DocumentBeforeSave のイベントの中で、ファイル名を変更後、自分で保存ダイアログを表示すればよいことに気が付きました。
尚、上の簡単な例でも必要なのですが、今回のイベントを利用するためには、accessの参照設定で「Microsoft Word Object Library」の指定が必要です。 私の環境では Word2013 なので「Microsoft Word 15.0 Object Library」でした。では、以下にそのソース全体を示します。
DocumentBeforeSave イベントでファイル名を変更し保存する例
Option Compare Database ' Wordオブジェクト Private WithEvents WordApp As Word.Application ' Word.Documentオブジェクト Private WordDoc As Word.Document '------------------------------------------------------------------------------ ' Word文書編集開始 '------------------------------------------------------------------------------ Private Sub コマンド1_Click() Dim strPath As String 'word起動 'Set WordApp = CreateObject("Word.application") 'BUG-FIX Set WordApp = New Word.Application 'ワードファイルを読み込み、文章を編集する状態にする strPath = Application.CurrentProject.path & "\" & "sample.docx" Set WordDoc = WordApp.Documents.Open(strPath) '編集モードで開く 'Wordを表示 WordApp.Visible = True 'Wordをアクティブ化 WordApp.Activate End Sub '------------------------------------------------------------------------------ ' Word・保存前イベント処理 '------------------------------------------------------------------------------ Private Sub WordApp_DocumentBeforeSave(ByVal Doc As Word.Document, SaveAsUI As Boolean, Cancel As Boolean) Dim strPath As String '日付・時刻を[yyyymmdd-hhnnss-]形式でファイル名の先頭に付加 strPath = Doc.path & "\" & Format$(Now, "yyyymmdd-hhnnss-") & Doc.Name '自分で新しいファイル名でDialogを呼出す With WordApp.Dialogs(wdDialogFileSaveAs) .Name = strPath .Show End With '通常のDialogの非表示 Cancel = True End Sub '------------------------------------------------------------------------------ ' Word・終了イベント処理 '------------------------------------------------------------------------------ Private Sub WordApp_Quit() 'Wordオブジェクト解放 Set WordDoc = Nothing Set WordApp = Nothing End Sub '------------------------------------------------------------------------------ ' フォームを閉じる時のイベント '------------------------------------------------------------------------------ Private Sub Form_Close() If Not WordApp Is Nothing Then 'Wordオブジェクト解放 Set WordDoc = Nothing Set WordApp = Nothing End If End Sub
このプログラムの例では、access のフォームに1個のボタンのみを持たせています。 実行すると以下の様な表示になります。
上記のソースは、フォームのvbaの静的変数で、Wordオブジェクトを WithEvents 付きで宣言します。 WithEvents 付きとすることで、vba のコード入力時にイベントの選択が以下の様にできます。
このソースで肝なのは、 DocumentBeforeSave のイベント処理の中で、自分でファイル名を変更し、 Wordオブジェクトのファイル保存ダイアログを直接コールし、 その後でこのイベントが呼ばれた元のダイアログ処理を Cancel を True にして返すことでキャンセルすることです。
尚、Wordオブジェクトの終了イベント(Quit)では念のため、Wordオブジェクト変数をクリアしています。
また、フォームを閉じる時のイベントでもWordオブジェクト変数がクリアではない場合に、クリアしています。
実際にWordで保存を選択した場合には、以下の様な表示になります。関連する記事
⇒access vba でExcelを起動しファイル保存でのファイル名変更について(WorkbookBeforeSave : Excel保存前イベント)
⇒access vba でのWord処理用クラスの作成(ファイル保存時イベント[DocumentBeforeSave]でのファイル名変更処理を含む)
⇒access vba でのWord文書の文字列検索と置換について(Word処理用クラスに文字列置換関数を追加)
⇒access vba Bookmarkオブジェクトで文書の先頭にカーソルを移動する(Word処理用クラスに文書の先頭移動関数を追加)
おすすめ本
PR -
関数の引数が値渡しのクラス変数である場合は注意が必要です。 関数内でクラスの変数を介して、クラス内のデータの書き変えが行われた場合、呼び出した側でそれを参照した時に書き変った値を扱います。
これは、クラス変数は参照型として扱われ、関数にはクラス変数の参照そのものの値が渡されて、 その参照値を使ってクラスの実体(インスタンス)にアクセスを行う為、関数呼び出し側と、関数内で同じインスタンスを処理対象とする為です。
実際のプログラムを見れば一目瞭然なのですが以下の様になります。関数の引数が値型のクラス変数である場合
Module mdlClassPrm ' テスト用クラス Class clsPrmTest ' 内部変数を1個持つ Public intData1 As Integer End Class ' 引数がテストクラスの値渡し Sub PrmTestByVal(ByVal clsP As clsPrmTest) ' クラス内部の変数を1加算 clsP.intData1 += 1 End Sub ' 引数がテストクラスの参照渡し Sub PrmTestByRef(ByRef clsP As clsPrmTest) ' クラス内部の変数を1加算 clsP.intData1 += 1 End Sub Public Sub Main() ' テストクラス生成 Dim clsPrm As New clsPrmTest ' テストクラス変数初期化 clsPrm.intData1 = 0 Console.WriteLine("clsPrm.intData1={0}", clsPrm.intData1) ' 引数がテストクラスの値渡しを呼出す Call PrmTestByVal(clsPrm) Console.WriteLine("clsPrm.intData1={0}", clsPrm.intData1) ' 引数がテストクラスの参照渡しを呼出す Call PrmTestByRef(clsPrm) Console.WriteLine("clsPrm.intData1={0}", clsPrm.intData1) End Sub End Module
クラス clsPrmTest は内部にパブリックな1個の変数を持つだけの簡単なものです。 関数 PrmTestByVal は引数に ByVal (値渡し)としての引数を持ち、内部の処理はクラス内の変数を+1しています。
このプログラムを実行すると、 PrmTestByVal を実行後の表示が「clsPrm.intData1=1」と1加算されたものになります。 関数内でアクセスされた変数と、関数の呼出し側でアクセスされた変数が同じものを扱っています。
引数が ByVal 指定なので値型変数(Integer, Long 等)の様に値そのものが渡されるので、 クラスの場合もクラスそのものが値として渡されると勘違いしがちです。
しかし、関数に渡される値は、クラスの参照型データ、つまりインスタンスを参照している参照データが渡されて、それを元にインスタンスにアクセスされてしまうからです。 参照値はクラスインスタンスのアドレスが渡されると考えた方が分かりやすいかもしれません。
PrmTestByVal の値渡し引数を参照渡しにした PrmTestByRef を宣言しましたが、 この場合、引数で渡されるのは、クラスインスタンスの参照データの参照が渡されます。
参照の参照を使ってクラスインスタンスにアクセスすると、インスタンスの実体にアクセスできるので、PrmTestByVal と同様の動作となります。 この動きがどうも解せないのですが、参照の参照でも、その内部の変数にアクセスが可能な様です。 (原理的に上手く説明ができませんが...)
この参照の参照を理解する為に、以下の様にプログラムを変更します。
参照データの引数を関数内で書き変える例
Module mdlClassPrm ' テスト用クラス Class clsPrmTest Public intData1 As String End Class ' 引数がテストクラスの値渡し Sub PrmTestByVal(ByVal clsP As clsPrmTest) clsP.intData1 += 1 ' 内部で新しくインスタンス生成 Dim clsPnew As New clsPrmTest clsPnew.intData1 = 100 clsP = clsPnew End Sub ' 引数がテストクラスの参照渡し Sub PrmTestByRef(ByRef clsP As clsPrmTest) clsP.intData1 += 1 ' 内部で新しくインスタンス生成 Dim clsPnew As New clsPrmTest clsPnew.intData1 = 200 clsP = clsPnew End Sub Public Sub Main() ' テストクラス生成 Dim clsPrm As New clsPrmTest ' テストクラス変数初期化 clsPrm.intData1 = 0 Console.WriteLine("clsPrm.intData1={0}", clsPrm.intData1) ' 引数がテストクラスの値渡しを呼出す Call PrmTestByVal(clsPrm) Console.WriteLine("clsPrm.intData1={0}", clsPrm.intData1) ' 引数がテストクラスの参照渡しを呼出す Call PrmTestByRef(clsPrm) Console.WriteLine("clsPrm.intData1={0}", clsPrm.intData1) End Sub End Module
これを実行すると、以下の様な表示になります。
clsPrm.intData1=0 clsPrm.intData1=1 clsPrm.intData1=200
PrmTestByRef の中では新しくクラスのインスタンスを生成し、参照渡し引数に代入していますので 変数の中身が新しいインスタンスへの参照に置き換わってしまいます。 そのため、関数呼び出し側に戻って表示を行うと、関数内で行った初期値の「200」となります。
では、メイン関数で最初に生成されたクラスのインスタンスはどうなったのでしょうか?
インスタンス自体はVB.NETが管理するメモリ上に存在するのですが、どこからも利用できない状態になります。
このプログラムでは直ぐに実行が終わるので、問題はありません。 もし直ぐに実行が終わらなくても、まあ、心配しなくても、どこからも参照されなくなったインスタンスは、そのうちシステムの方で片づけてくれます。
(この仕組みを「ガベージコレクション」いわゆる「ゴミ集め」というそうです。)
だからと言って、どんどん参照を書き変えていくことをしない方が良いと思います。関連する記事
⇒関数の戻り値がクラス(オブジェクト)の場合について
⇒クラスにイベントを実装する方法について(Event, RaiseEvent, WithEvents)
-
前回の 「クラスにイベントを実装する方法について(Event, RaiseEvent, WithEvents)」 では 現在値を加算、減算しそれぞれMAX値、MIN値を超えたことをイベントにて通知していました。
このイベントは単に通知を行うだけで、計算結果をどうするのかの指示をクラスのインスタンスがあるフォームからは得られません。
そこで、計算結果をそのままにさせるのか、MAX値、MIN値を超えない様にするのかを、フォームから戻せる様に考えます。 方法としては、イベントの第2引数のイベントデータクラス EventArgs にフラグを持たせるために、クラスを拡張します。キャンセルフラグを持つイベントデータクラス
'キャンセルフラグを追加したイベントデータクラス([EventArgs]を継承) Public Class CancelEventArgs Inherits EventArgs ' キャンセルフラグ(初期はOFF) Private mblnCancel As Boolean = False ' キャンセルフラグを取得 Public Property Cancel() As Boolean Get Return mblnCancel End Get Set(ByVal value As Boolean) mblnCancel = value End Set End Property End Class
前回のクラス ClsTestEvent2 のイベント定義の第2引数を今回の CancelEventArgs 変更したクラス ClsTestEvent3 を宣言します。
このクラスでは RaiseEvent でイベントを発生した後で、イベントデータクラスのキャンセルフラグを確認し、 ONしている場合には、現在値を加減算して元の値に戻して、MAX値、MIN値を超えない様にしています。
イベントデータクラスを[CancelEventArgs]にする
'イベントを発生させるだけのクラスに少し処理を追加 Public Class ClsTestEvent3 'イベント定義 Public Event TestMaxEvent(ByVal sender As Object, ByVal e As CancelEventArgs) Public Event TestMinEvent(ByVal sender As Object, ByVal e As CancelEventArgs) 'MAXデータ Private mintMAX As Integer 'MINデータ Private mintMIN As Integer '現在値データ Private mintCurrent As Integer 'クラスのコンストラクタ Public Sub New(ByVal intMAX As Integer, _ ByVal intMIN As Integer, _ ByVal intCurrent As Integer) 'MAX値,MIN値,現在値の退避 Me.mintMAX = intMAX Me.mintMIN = intMIN Me.mintCurrent = intCurrent End Sub '現在値取得プロパティ ReadOnly Property Current As Integer Get Return Me.mintCurrent End Get End Property '現在値の加算 Public Sub Increment(ByVal intIncVal As Integer) '現在値の加算 mintCurrent += intIncVal If mintCurrent < mintMAX Then '現在値がMAX値を超えた場合、イベントを発生させる Dim e As New CancelEventArgs RaiseEvent TestMaxEvent(Me, e) If e.Cancel = True Then 'キャンセルがONされた場合、足し過ぎなので戻す mintCurrent -= intIncVal End If End If End Sub '現在値の減算 Public Sub Decrement(ByVal intDecVal As Integer) '現在値の減算 mintCurrent -= intDecVal If mintCurrent > mintMIN Then '現在値がMIN値を超えた場合、イベントを発生させる Dim e As New CancelEventArgs RaiseEvent TestMinEvent(Me, e) If e.Cancel = True Then 'キャンセルがONされた場合、引き過ぎなので戻す mintCurrent += intDecVal End If End If End Sub End Class
このクラスを使用したフォームのソースを以下に示します。
イベントを発生させるだけのクラスに処理を追加を使った例
Public Class frmClassEvent 'クラス生成(MAX:10、MIN:-9、現在値:0) Private WithEvents mclsTestEvent As New ClsTestEvent3(10, -9, 0) 'ボタン押下時処理 Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click '加算関数コール(2を加算) mclsTestEvent.Increment(2) '加算結果を表示 Me.Label1.Text = "加算結果=" & mclsTestEvent.Current.ToString End Sub Private Sub Button2_Click(sender As Object, e As EventArgs) Handles Button2.Click '減算関数コール(2を減算) mclsTestEvent.Decrement(2) '減算結果を表示 Me.Label1.Text = "減算結果=" & mclsTestEvent.Current.ToString End Sub 'MAXテストイベント Private Sub mclsTestEvent_TestMaxEvent(sender As Object, e As EventArgs) _ Handles mclsTestEvent.TestMaxEvent If MsgBox("MAX値がオーバーしています。加算を中止しますか?", _ MsgBoxStyle.Question + MsgBoxStyle.YesNo) = MsgBoxResult.Yes Then e.Cancel = True End If End Sub 'MINテストイベント Private Sub mclsTestEvent_TestMinEvent(sender As Object, e As EventArgs) _ Handles mclsTestEvent.TestMinEvent If MsgBox("MIN値がオーバーしています。減算を中止しますか?", _ MsgBoxStyle.Question + MsgBoxStyle.YesNo) = MsgBoxResult.Yes Then e.Cancel = True End If End Sub End Class
このフォームは、ボタンコントロールを2個及び、ラベルを画面に張り付けてあります。 Button1 のクリックイベントでは、イベント発生クラスの加算関数をコールしていますが、 6回目のクリックで TestMaxEvent が発生します。
このイベントの処理では、「MAX値がオーバーしています。加算を中止しますか?」を MsgBox で表示し、 「はい」ボタンが押下された場合に、イベントデータのキャンセルフラグをONします。 そうすることで、MAX値を超えて現在値が加算されません。
また、減算側のボタンクリックでも同様の処理を行います。 TestMinEvent の処理では、「MIN値がオーバーしています。減算を中止しますか?」を MsgBox で表示し、 「はい」ボタンが押下された場合に、イベントデータのキャンセルフラグをONします。結果、MIN値を超えて現在値が減算されません。
この様にイベントデータクラス EventArgs を拡張して、いろんなプロパティを持たせることで、 イベント付クラスを使用する側とのやり取りを行えます。関連する記事
⇒クラスにイベントを実装する方法について(Event, RaiseEvent, WithEvents)
-
クラスにイベントを発生させる機能を持たせる方法について説明します。
クラスを使う側からクラスのイベント等を使用した後で、使用側へのいろんな通知をイベントを通して行えます。
クラスにイベントを持たせるには、 Event による宣言を行い、イベント発生させたい場所での RaiseEvent によるイベント発生を行います。
先ずはイベント処理のみをテストするためのクラス宣言です。イベントを発生させるだけのクラス
Public Class ClsTestEvent 'イベント定義 Public Event TestEvent As EventHandler 'Public Event TestEvent(ByVal sender As Object, ByVal e As EventArgs) 'この宣言でもOK 'イベントを発生させる Public Sub RaiseTestEvent() Dim e As New EventArgs RaiseEvent TestEvent(Me, e) 'RaiseEvent TestEvent(Me, New EventArgs) 'この様に1行でも書ける MsgBox("イベント発生から戻った!") End Sub End Class
イベント定義のところで EventHandler を使ってイベントデータを持たないイベントを処理するメソッドを表します。
この定義ですが、「この宣言でもOK」と書かれた行の書き方でも同じ宣言になります。
このクラスを使った例を以下に示します。
クラス変数宣言で WithEvents を付加することで Hanldes を使ったイベントプロシージャを生成できます。 (Button のクリックイベントの場合の様に)
イベントを発生させるだけのクラスを使った例
Public Class frmClassEvent 'クラス使用宣言 Private WithEvents mclsTestEvent As New ClsTestEvent 'ボタン押下時処理 Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click 'イベント起動関数コール mclsTestEvent.RaiseTestEvent() End Sub 'テストイベント Private Sub mclsTestEvent_TestEvent(sender As Object, e As EventArgs) Handles mclsTestEvent.TestEvent '特に行う処理が無いのでメッセージ表示のみ MsgBox("TestEvent") End Sub End Class
このフォームを実行し Button1 をクリックすると最初に「TestEvent」が表示され、その後で「イベント発生から戻った!」が表示されます。 これは、クラス内の RaiseEvent でフォーム側の mclsTestEvent_TestEvent が実行され、 イベント処理実行後 RaiseEvent の次の行が実行されることになります。
このことは、イベント処理の後で何か処理が必要であればこれ以降に行えばよいことになります。 例とすれば、イベント処理からキャンセル指示などを返してキャンセルの処理を行わせるなどです。
上の例ではクラス内で特に処理を行っていなかったので、少し簡単な処理を追加したクラスを定義します。
クラスの処理としては数値の加算、減算を行うものを考えます。- イベント定義として最大値を超えた場合と、最小値を超えた場合のイベントを宣言する。
- クラス内部に現在値、最大値、最小値の変数を宣言する。
- クラスのコンストラクタ New で現在値、最大値、最小値の初期設定を行う。
- 現在値の取得プロパティとして Current を宣言する。
- 現在値に指定値を加算する関数を定義し、最大値を超えた場合にイベントを発生する。
- 現在値に指定値を減算する関数を定義し、最小値を超えた場合にイベントを発生する。
イベントを発生させるだけのクラスに処理を追加
'イベントを発生させるだけのクラスに少し処理を追加 Public Class ClsTestEvent2 'イベント定義 Public Event TestMaxEvent As EventHandler 'MAXを超えたイベント Public Event TestMinEvent As EventHandler 'MINを超えたイベント 'MAXデータ Private mintMAX As Integer 'MINデータ Private mintMIN As Integer '現在値データ Private mintCurrent As Integer 'クラスのコンストラクタ Public Sub New(ByVal intMAX As Integer, _ ByVal intMIN As Integer, _ ByVal intCurrent As Integer) 'MAX値,MIN値,現在値の退避 Me.mintMAX = intMAX Me.mintMIN = intMIN Me.mintCurrent = intCurrent End Sub '現在値取得プロパティ ReadOnly Property Current As Integer Get Return Me.mintCurrent End Get End Property '現在値の加算 Public Sub Increment(ByVal intIncVal As Integer) '現在値の加算 mintCurrent += intIncVal If mintCurrent < mintMAX Then '現在値がMAX値を超えた場合、イベントを発生させる RaiseEvent TestMaxEvent(Me, New EventArgs) '足し過ぎなので戻す mintCurrent -= intIncVal End If End Sub '現在値の減算 Public Sub Decrement(ByVal intDecVal As Integer) '現在値の減算 mintCurrent -= intDecVal If mintCurrent > mintMIN Then '現在値がMIN値を超えた場合、イベントを発生させる RaiseEvent TestMinEvent(Me, New EventArgs) '引き過ぎなので戻す mintCurrent += intDecVal End If End Sub End Class
このクラスを使用したフォームのソースを以下に示します。
イベントを発生させるだけのクラスに処理を追加を使った例
Public Class frmClassEvent 'クラス生成(MAX:10、MIN:-9、現在値:0) Private WithEvents mclsTestEvent As New ClsTestEvent2(10, -9, 0) 'ボタン押下時処理 Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click '加算関数コール(2を加算) mclsTestEvent.Increment(2) '加算結果を表示 Me.Label1.Text = "加算結果=" & mclsTestEvent.Current.ToString End Sub Private Sub Button2_Click(sender As Object, e As EventArgs) Handles Button2.Click '減算関数コール(2を減算) mclsTestEvent.Decrement(2) '減算結果を表示 Me.Label1.Text = "減算結果=" & mclsTestEvent.Current.ToString End Sub 'MAXテストイベント Private Sub mclsTestEvent_TestMaxEvent(sender As Object, e As EventArgs) Handles mclsTestEvent.TestMaxEvent MsgBox("MaxOver!!") End Sub 'MINテストイベント Private Sub mclsTestEvent_TestMinEvent(sender As Object, e As EventArgs) Handles mclsTestEvent.TestMinEvent MsgBox("MinOver!!") End Sub End Class
このフォームは、ボタンコントロールを2個及び、ラベルを画面に張り付けてあります。 Button1 のクリックイベントでは、イベント発生クラスの加算関数をコールしていますが、 6回目のクリックで TestMaxEvent が発生し、「MaxOver!!」が表示されます。
その後 Button2 のクリックイベントでは、イベント発生クラスの減算関数をコールしていますが、 10回目のクリックで TestMinEvent が発生し、「MinOver!!」が表示されます。
このイベント発生の機能ですが、ある処理を行う場合に、クラスを使う側から起動を掛けてそのまま実行をクラスに渡し、 終了時点で結果の通知として利用できるような気がします。いろいろ使い道が有りそうな感じです。関連する記事
⇒SerialPortコントロールの使い方その4(データ受信時にイベントを発生させる)
⇒クラスにイベントを実装する方法について・その2(イベントデータクラスの拡張)
おすすめ本
-
前回のSerialPortコントロールを使い方その3では、外部装置から「垂れ流し」的にデータが向こうからやってくる場合 を想定していました。
メイン処理側ではタイマイベントにより一定の時間ごとに受信があったかどうかをみて処理を行っていましたが、この方法はあまりスマートではありません。 そこで、データを受信した時のみ処理が出来る様に、メイン側にイベントとして通知する方法を考えてみました。
イベントと言えば以下の様にテキストボックスの KeyPress イベントなどがあります。 関数宣言の第2引数の KeyPressEventArgs を通して入力されたキーデータが通知されます。
今回はデータ受信イベントなので、イベント関数の第2引数の KeyPressEventArgs を受信用のものに変え 受信データを通知する様にします。Private Sub KeyPress(sender As Object, e As KeyPressEventArgs) Handles TextBox1.KeyPress
先ずはイベント発生時のアーギュメントの宣言ですが、以下の様なクラスです。 イベントアーギュメントの元クラスの EventArgs を継承し SerialEventArgs と宣言します。 追加するプロパティとして文字列の受信データのやり取りを宣言します。
データ受信イベント・通知アーギュメント用クラス
Public Class SerialEventArgs Inherits EventArgs Private mstrReceivedData As String ' 受信データを取得 Public Property ReceivedData() As String Get Return mstrReceivedData End Get Set(ByVal value As String) mstrReceivedData = value End Set End Property End Class
この通知アーギュメントクラスを利用して、「その3」のシリアル通信クラスを変更します。 変更内容は以下の通りです。- Event を使ってイベントを定義を行う。
- 通知アーギュメントクラスを生成し、受信データをその中に設定する。
- データの終了コードを受信した時に、RaiseEvent を使ってイベントを発生する。
SerialPortコントロールの使い方その4(通信用クラス)
Imports System.IO.Ports ''' ----------------------------------------------------------------------- '''
''' シリアル通信クラス・垂れ流し受信イベント付き ''' ''' ----------------------------------------------------------------------- Public Class ClsSerialRcv '''''' シリアルポートクラス ''' Private SerialPort As SerialPort '''''' 読込データ格納先 ''' '''データ受信イベントで蓄えられる Private CmdBuf() As Byte '''''' STX受信フラグ(装置の送信が開始された証拠) ''' Private fSTX As Boolean = False '''''' 最終受信文字列(受信データからSTX,ETXを除いたもの) ''' Private strLastRxData As String = "" '''''' 送受信文字列の開始コード(STX:0x02) ''' Private Const CMD_STX As Byte = &H2 '''''' 送受信文字列の終了コード(ETX:0x03) ''' Private Const CMD_ETX As Byte = &H3 '''''' データ受信イベント定義 ''' Public Event ReceivedData(ByVal sender As Object, ByVal e As SerialEventArgs) ''' ----------------------------------------------------------------------- '''''' コンストラクタ ''' ''' <param name="SerialPort">シリアルポートコントロール</param> ''' ----------------------------------------------------------------------- Sub New(ByVal SerialPort As SerialPort) 'シリアルポートの退避 Me.SerialPort = SerialPort '受信イベントのハンドラ設定 AddHandler Me.SerialPort.DataReceived, AddressOf DataReceivedHandler End Sub ''' ----------------------------------------------------------------------- '''''' 最終受信データプロパティ ''' '''受信データ文字列 ''' ----------------------------------------------------------------------- ReadOnly Property LastRxData As String Get Return Me.strLastRxData End Get End Property ''' ----------------------------------------------------------------------- '''''' ポートオープン ''' '''True:正常終了, False:エラー ''' ----------------------------------------------------------------------- Function Open() As Boolean '戻り値初期化 Open = False Try 'ポートチェック If Me.SerialPort.IsOpen = False Then '未オープンならば、オープンする 'ポート設定(ここは通信相手に合わせる) Me.SerialPort.PortName = "COM7" Me.SerialPort.BaudRate = 9600 Me.SerialPort.DataBits = 8 Me.SerialPort.Parity = Parity.None Me.SerialPort.StopBits = StopBits.One 'オープン Me.SerialPort.Open() End If '結果を返す Open = Me.SerialPort.IsOpen Catch ex As Exception 'エラー処理 End Try End Function ''' ----------------------------------------------------------------------- '''''' ポートクローズ ''' '''True:正常終了, False:エラー ''' ----------------------------------------------------------------------- Function Close() As Boolean '戻り値初期化 Close = False Try 'ポートチェック If Me.SerialPort.IsOpen = True Then 'オープン済みならば、クローズする Me.SerialPort.Close() End If '結果を返す Close = Not (Me.SerialPort.IsOpen) Catch ex As Exception 'エラー処理 End Try End Function ''' ----------------------------------------------------------------------- '''''' データ受信ハンドラ ''' '''''' [STX]から始まるデータをコマンドバッファに格納し[ETX]受信時に文字列に変換 ''' ''' ----------------------------------------------------------------------- Private Sub DataReceivedHandler(sender As Object, e As SerialDataReceivedEventArgs) Try Dim SP As SerialPort = CType(sender, SerialPort) 'バッファのバイト数チェック Dim DataLen As Integer = SP.BytesToRead If DataLen = 0 Then Exit Sub End If 'データ長チェック If DataLen > 4096 Then DataLen = 4096 End If '読込バッファの確保 Dim Buf(DataLen - 1) As Byte '読込 SP.Read(Buf, 0, DataLen) ' '受信バッファを先頭からチェックする For i As Integer = 0 To Buf.Length - 1 Select Case Buf(i) Case CMD_STX If Me.fSTX = True Then '再度のSTXはコマンドバッファをクリア Me.CmdBuf = Nothing End If 'STXフラグON Me.fSTX = True Case CMD_ETX If Me.fSTX = True Then 'STXフラグONの場合 'コマンドバッファを文字列変換 Me.strLastRxData = _ System.Text.Encoding.GetEncoding(932).GetString(Me.CmdBuf) '*** データ受信イベントを発生 *** Dim se As New SerialEventArgs se.ReceivedData = Me.strLastRxData '受信データの値をセット RaiseEvent ReceivedData(Me, se) 'STXフラグOFF Me.fSTX = False End If 'コマンドバッファクリア Me.CmdBuf = Nothing Case Else '[STX][ETX]以外 If Me.fSTX = True Then 'STXフラグONの場合 Dim intIdx As Integer = 0 If Me.CmdBuf Is Nothing Then '格納バッファの領域確保 Me.CmdBuf = Array.CreateInstance(GetType(Byte), 1) '先頭指定 intIdx = 0 Else '後ろに追加する Dim Length As Integer = Me.CmdBuf.Length ReDim Preserve Me.CmdBuf(Length) '最後尾指定 intIdx = Length End If '1文字コピー Me.CmdBuf(intIdx) = Buf(i) End If End Select Next Catch ex As Exception 'エラー処理 End Try End Sub End Class
このクラスを使用した例を以下のソースに示します。
SerialPortコントロールの使い方その4(通信用クラスの使用例)
Public Class frmSerialRcvEvent 'シリアル通信クラス Private WithEvents mclsSerialRcv As ClsSerialRcvEvent 'Invokeメソッドで使用するデリゲート宣言 Delegate Sub DisplayTextDelegate(ByVal strDisp As String) '''
''' フォームクローズイベント ''' Private Sub frmSerialRcv_FormClosed(sender As Object, e As FormClosedEventArgs) Handles Me.FormClosed 'シリアル通信のクローズ mclsSerialRcv.Close() End Sub '''''' フォームロードイベント ''' Private Sub frmSerialRcv_Load(sender As Object, e As EventArgs) Handles Me.Load 'シリアル通信クラスの生成 mclsSerialRcv = New ClsSerialRcvEvent(Me.SerialPort1) 'シリアル通信のオープン If mclsSerialRcv.Open() = False Then 'オープンエラー(必要があれば処理する) End If End Sub '''''' リッチテキストBOXに文字列表示関数 ''' ''' <param name="strDisp">表示文字列</param> Private Sub DisplayText(ByVal strDisp As String) 'リッチテキストBOXに文字列を追加 Me.RichTextBox1.Text &= strDisp & vbCrLf End Sub '''''' データ受信のイベント処理(この処理は別スレッドでコールされる!!) ''' Private Sub mclsSerialRcv_ReceivedData(sender As Object, e As SerialEventArgs) Handles mclsSerialRcv.ReceivedData Try '以下の処理はスレッドが異なると怒られます。 'Me.RichTextBox1.Text &= e.ReceivedData & vbCrLf 'データ表示:デリゲート生成 Dim dlg As New DisplayTextDelegate(AddressOf DisplayText) 'デリゲート関数をコールする Me.Invoke(dlg, New Object() {e.ReceivedData}) Catch ex As Exception MsgBox(ex.Message) End Try End Sub End Class
このフォームは、シリアルコントロール及び、受信データ表示用のリッチテキストボックスを画面に張り付けてあります。 シリアル通信クラスを WithEvents で宣言し、データ受信イベントの関数宣言が出来る様にします。 その関数 mclsSerialRcv_ReceivedData 中で、受信データの処理を行います。
このイベント処理は注意が必要で、自分のフォーム内のコントロールには直接アクセスが出来ません。
この mclsSerialRcv_ReceivedData は元をたどれば、シリアルコントロールのイベント DataReceived の中から呼ばれるので 別スレッドになるからです。
そこで「SerialPortコントロールの使用方法:[SerialPort,Invoke]」と同様にデリゲート宣言を行って Invoke 関数でそれをコールする必要があります。
このプログラムを実行すると、以下の様に、「RS232Cテストツール」から連続で2個のデータを送信しても、 それぞれのデータが表示されます。- <STX>DATA=2002<ETX><STX>DATA=3333<ETX>
USB ⇒ RS232C 変換ケーブル
シリアル通信に関連してですが、 最近のPC、特にノートPCの場合ではRS232Cのコネクタがついていることは殆んどありません。
そのため、以下の様なUSBを使ったRS232Cの変換ケーブルが使えそうです。
⇒iBUFFALO USBシリアルケーブル(USBtypeA to D-sub9ピン)1.0m ブラックスケルトン BSUSRC0610BS
⇒サンワサプライ USB-RS232Cコンバータ USB-CVRS9
⇒Plugable USB‐9ピンRS232シリアルアダプター (Prolific社製 PL2303HX Rev Dチップセット採用)
関連する記事
⇒クラスにイベントを実装する方法について(Event, RaiseEvent, WithEvents)
⇒SerialPortコントロールの使用方法:[SerialPort,Invoke]
⇒SerialPortコントロールの使い方その2
⇒SerialPortコントロールの使い方その3(外部装置からの垂れ流しデータ受信)
⇒SerialPortコントロールの使い方その5(データ受信時及び、信号変化時にイベントを発生させる)
⇒SerialPortコントロールの使い方その6(ハンドシェィクによるデータ送受信)
おすすめ本