VB.NET RaiseEventについて

Question

VisualStudio2019にて、Windowsアプリケーションを開発しています。
そこで、ユーザーコントロールの知識が必要になり勉強している最中です。

Get_Eventという名前でユーザーコントロールを作成し、テキストボックスを３つ置きました。

Form1側にGet_EventとTextBox1を配置しました。

Get_Event内のテキストボックスがFocusされた時にEventを発生し、
TextBox1にどのテキストボックスがFocusされているかとテキストボックスの内容をTextBox1に表示したいです。

Public Event BoxClick(ByVal sender As Control, ByVal e As System.EventArgs)

Private Sub cbox_Click(ByVal sender As Object, ByVal e As System.EventArgs)
    RaiseEvent BoxClick(sender, e)
End Sub

よろしくお願い申し上げます。

Comments

[y_waiwai]

ききたいことはなんでしょうか

[Kruth]

y_waiwaiさん

わかりづらくてすみません
TextBox1にどのテキストボックスがFocusされているかとテキストボックスの内容をTextBox1に表示するためにはどのように記載すればいいんでしょうか...
Eventの順序すらわからない状態です。

Answer 1

サンプル投下します。

ユーザーコントロールのコード

<System.ComponentModel.DefaultEvent("BoxClick")>
Public Class Get_Event

    Protected Overrides Sub OnLoad(e As EventArgs)
        MyBase.OnLoad(e)
        For Each ctrl As Control In Me.Controls
            AddHandler ctrl.Enter, AddressOf ctrl_Enter
        Next
    End Sub

    Private Sub ctrl_Enter(ByVal sender As Object, ByVal e As EventArgs)
        RaiseEvent BoxClick(Me, New BoxClickEventArgs(DirectCast(sender, Control)))
    End Sub

    Public Event BoxClick(ByVal sender As Control, ByVal e As BoxClickEventArgs)

End Class

Public Class BoxClickEventArgs
    Inherits EventArgs

    Public ReadOnly Property Current As Control

    Public Sub New(ctrl As Control)
        Me.Current = ctrl
    End Sub

End Class

使い方

Public Class Form1

    Private Sub Get_Event1_BoxClick(sender As Control, e As BoxClickEventArgs) Handles Get_Event1.BoxClick
        TextBox1.Lines = New String() {"Focus:" & e.Current.Name, "Text :" & e.Current.Text}
    End Sub

End Class

Comments

[Kruth]

回答ありがとうございます。

コピペして実行して動きを確認させていただきました。
完全にやりたかったことがこれです。

今後自分で機能を追加していったりしたいのですが、何を勉強したらいいんでしょうか？
よければ教えていただけませんか？

[KOZ6.0]

何を？って難しいですね・・・
とりあえず dobon さんのサイトに載っているサンプルを片っ端から読み漁ってみるのはどうでしょう。
http://dobon.net/vb/dotnet/
やりたいことは、たいてい載っているんじゃないかと思います。

[Kruth]

ありがとうございます。
記載いただいたサイト拝見してみます。

どこでEventをキャッチして、どのようにして値を返してるのかが全然掴めません。
もし、お手すきでしたらそちらの解説をいただけたら幸いです。

また、ベストアンサーに選んでしまうとやり取りは出来なくなりますか？

[KOZ6.0]

少し難しいこと、トリッキーな事をしたりしていれば解説しますが、このサンプルはそうではありません。
OnLoad って何？とか AddHandler って何？とかは、すべて Microsoft のサイトを調べればわかります。
そういうのを調べるのも勉強のうちですよ。

[Kruth]

わからない行を全て調べて学んでみます。

またわからなければ質問させてください。
本当にありがとうございました。

[Kruth]

すみません、記載いただいたコードの意味がだいぶわかってきました。

そこで１つ疑問な点があるんですが、なんでわざわざctrl_EnterをEnterイベントに追加してるんですか？
BoxClickを追加したらもっとわかりやすいと思ったんですが、引数の型が変わるから段階を踏んでるイメージですか？

[Kruth]

ctrl_EnterはあくまでCurrentにコントロールを記憶するためのものって考えたらいいんですかね...ぼんやりとわけてる理由はわかるんですが、正確にはわからないです...。

[YAmaGNZ]

TextBoxがフォーカスを得る→Enterイベントが発生する→ユーザーコントロールからフォームへ通知する必要があるのでBoxClickを発生させる
という順番です。

「記述を分けている」というわけではありません。
BoxClickイベントは自分で作成したイベントなので自分で発生させる（RaiseEventを呼ぶ）必要があります。

[Kruth]

すみません、
ユーザーコントロールからフォームへ通知する必要があるのでBoxClickを発生させる
この部分がよくわかりません...。

BoxClickを自分で呼ぶ必要性もわかりました。
Form1で
) Handles Get_Event1.BoxClick
BoxClickを追加している意味があまりわかってないみたいです...。

[KOZ6.0]

このあたりを読むとわかるかも。
http://rucio.o.oo7.jp/VBNyumon/BEGIN4.htm

[Kruth]

読みました。

そこで　BoxClickEventArgs　をクラスで定義する意味はなんででしょうか？
EventArgsの意味があまりわかってないので調べているんですが、自作のEventArgsについて
書かれている記事が全然なく困ってます。

[YAmaGNZ]

イベントの引数はイベントが発生したオブジェクト（sender）とそのイベントの付属データを格納するもの（EventArgs）としましょうというのがC#やVB.NETの一般的なルールとなっています。
自分で作成するイベントの場合、独自の必要なデータを渡したい（今回の場合ですと、フォーカスを持っているテキストボックスのNameやText）というのが出てきます。
そういったデータは標準のEventArgsには定義されていませんので自分でそういったデータを格納するものを作らなければなりません。
それがBoxClickEventArgsです。
このデータを渡すためのクラスの名称にも○○EventArgsとしましょうというルールがあります。
こういったルールに則っていれば、他人が見たときでもBoxClickEventArgsはBoxClickイベントで引数になるクラスなんだということがひと目で分かり、理解しやすくなります。

こうしなければならないという「文法」ではありませんので、このルールに従わなくても作成はできます。
ですが、ルールに従ったコーディングを行えば、誰が見ても分かりやすいコードになります。

[KOZ6.0]

ここを紹介しておきます。

「Visual Basic 初級講座」
http://rucio.a.la9.jp/main/dotnet/shokyu/index_sta.htm

「第４９回　イベントの作成」
http://rucio.o.oo7.jp/main/dotnet/shokyu/standard49.htm

[Kruth]

YAmaGNZさん
TextBox1.TextのTextだったりは既にEventArgsでコーディングされているから
いつでもその値を引き出せるっていうことですか・・・？

KOZ6.0さん
イベントの作成は全て拝見させていただきました。
YAmaGNZさんの解説をあわせて７割くらいは理解できたかなと思います。

お二人方大変ご丁寧にご教授いただきありがとうございました。

[YAmaGNZ]

今回のBoxClickイベントの場合はBoxClickEventArgsクラスのCurrentプロパティでフォーカスを得たコントロール（TextBox）を渡しています。
基本の「EventArgs」に関してはこちら（https://docs.microsoft.com/ja-jp/dotnet/api/system.eventargs?view=netframework-4.8）をご覧ください。

[Kruth]

RaiseEvent BoxClick(Me, New BoxClickEventArgs(DirectCast(sender, Control)))
この行で毎回新しい EventArgsが作成されて BoxClickEventArgsのCurrentにコントロールが保管される

認識はあってますか...？

[YAmaGNZ]

そのような認識であっています。

Dim args As BoxClickEventArgs
Dim textbox As Control

textbox = DirectCast(sender, Control)
args = New BoxClickEventArgs(textbox)
RaiseEvent BoxClick(Me, args)
と分解して書いたほうが分かりやすいですかね？

[Kruth]

なるほどです。

すごく理解できました。
分解コードもありがとうございます。

この知識を定着できるように似たようなサンプルを何個か作成してみます。
本当にありがとうございました。
また機会がありましたら、ご回答よろしくお願いします。

Answer 2

コンポーネントがフォーカスされた、アクティブコントロールになったときは、Enterイベントが発生します
そのときになんやかやすればいいでしょう

Comments

[Kruth]

Private Sub Get_Event_Enter(sender As Object, e As EventArgs) Handles Me.Enter
End Sub

ユーザーコントロールのEvent追加はこれであってますか...？

[y_waiwai]

VisualStudioでやってるなら、コントロールのプロパティでEnterイベントの欄をダブルクリックしたら作ってくれるでしょう

[Kruth]

Eventは追加出来ました。
YAmaGNZさんの回答を待ってみます。

Answer 3

イベントでのデータの渡し方が分からないということだと思いましたので、そちらに関して回答します。

Public Event BoxClick(ByVal sender As Control, ByVal e As BoxClickEventArgs)

Public Class BoxClickEventArgs
    Inherits EventArgs

　　Public ReadOnly Property Text As String

    Public Sub New(text As String)
        Me.Text = text
    End Sub

End Clas

Private Sub cbox_Click(ByVal sender As Object, ByVal e As System.EventArgs)
    Dim arg As New BoxClickEventArgs("渡すテキスト")
    RaiseEvent BoxClick(Me, arg)
End Sub

上記のように、イベントで渡すデータを格納するためのクラスを作成し、それを渡すようにすればよろしいかと思います。

単純に

Public Event BoxClick(TextBoxName As String,Text As String)

Private Sub cbox_Click(ByVal sender As Object, ByVal e As System.EventArgs)
    RaiseEvent BoxClick("TextBox名", "中身のテキスト")
End Sub

という書き方もできます。
しかし、イベント定義の標準的なルールから外れる形になりますのであまりお勧めはしません。

Comments

[Kruth]

ご回答ありがとうございます。

今やりたいことは、「ユーザーコントロールがFocusされた時にEventを発生させて、Form1のTextBox1にFocusされてるユーザーコントロール内のテキストボックス名とテキストボックス内容を取得したい」です。

[YAmaGNZ]

ですので、その発生させるイベントでテキストボックスの名前と内容を渡せるようにする方法が分からないと判断したのです。

違うのでしたら、分からないことを明確化して説明してください。

[Kruth]

すみません、やりたいことはそのとおりです。

クラスを別にもう１つ作るってことですか...？

[YAmaGNZ]

イベントの引数用のクラスを作らずに行うことも出来ますので、一応追記しましたが、一般的なルールから外れる形になりますのでお勧めはしません。
通常は最初に書いたように引数用のクラスを作成し～EventArgsという名称にします。

[Kruth]

実際にForm1に記載するコードは特にないということでしょうか？

[YAmaGNZ]

Form1にはそのイベントハンドラを書きます。
通常のコントロールのイベントと同様なので説明はしませんでした。
デザイナーでそのユーザーコントロールを配置したのであれば、デザイナー上でイベントハンドラの追加は行えます。