C# 子コントロールのイベントを親のユーザーコントロールに通知、定義させる

Question

こんにちは
C#で開発を進めている者です。
SplitterPanelのクリックイベントを親のUserControlに通知、定義する方法を探しています。

単純にSplitterPanelの数が固定であれば問題ないのですが、
SplitterPanelは追加、削除されることが前提で、
そのたびにSplitterPanelに対してイベントを付与する必要があり、
そのイベントを親のUserControlに通知、定義する方法を教えて頂ければとおもいます。

開発言語：C#
開発環境：VisualStudio2017

初投稿のため、情報不足等あるとはおもいますが、よろしくお願いいたします。

※※補足※※

構成は
ユーザーコントロール
→SplitContainerを拡張したコンポーネント
→SplitterPanelを拡張したコンポーネント
となっていて、SplitterPanelの作成、イベントの付与はSplitContainerを拡張した
コンポーネントで行っており、そこで作成されたSplitterPanelを拡張した
コンポーネントに対するイベントの発生を上のユーザーコントロールに通知する方法を
教えて頂きたいです。

Comments

[YAmaGNZ]

SplitterPanelを親コントロールで生成しているということでしょうか？
それなら、生成時にイベントハンドラを追加すればいいのではないでしょうか？

[damedameSE]

ご回答ありがとうございます。
説明不足で申し訳ございません。
構成は
ユーザーコントロール
　→SplitContainerを拡張したコンポーネント
　　→SplitterPanelを拡張したコンポーネント
となっています
SplitterPanelを作成しているのはSplitContainerを拡張したコンポーネントですので
このコンポーネントでの作成時に上のユーザーコントロールに通知したいということです。

[YAmaGNZ]

SplitterPanelはSplitContainerのみが見れる状態でユーザーコントロールからはアクセスできないということですか？
もし、ユーザーコントロールからSplitterPanelのインスタンスへのアクセス手段がないのであれば、イベントも直接通知するような形ではなく、一旦SplitContainerが受けて、そこから「SplitContainerがSplitterPanelがイベントを発生させた」といったイベントを作成し、SplitContainerからユーザーコントロールへイベントを起こすような形になるのではないでしょうか？

[damedameSE]

ご回答ありがとうございます。
ユーザーコントロールからSplitterPanelにアクセスすることも可能です。
それぞれの役割として
ユーザーコントロール
　SplitContainerにパネルの作成元となるデータのリストを渡す
SplitContainerを拡張したコンポーネント
　ユーザーコントロールから受け取ったリストを元に、SplitterPanelを拡張した
　コンポーネントを作成し、Click等のイベントを付与
といった形です。

SplitterPanelを拡張したコンポーネントに付与されたClickイベントを
どのようにユーザーコントロール側に通知すればよいのかがわからず質問させていただいた次第です。

[YAmaGNZ]

ユーザーコントロールからアクセスできるのであれば、作成した時にそのSplitterPanelのClickイベントに対してイベントハンドラを追加すればいいのでは？
というのが最初のコメントだったのですが・・・
SplitterPanel.Click += ～
といった感じで

[dameo]

@damedameSE
名前にとても親近感を覚えたので横から失礼します。
最近.NETは嵩張るので開発環境ごと消してしまったので適当ですが、
SplitContainer.ControlAdded/SplitContainer.ControlRemovedあたりのイベントを使うか、拡張しているなら自分でイベントを定義すればいいだけだと思います。親コントロールから各パネルをそこまでして制御したいユースケースが分かりませんが、実際にやりたいことがそれで実現できるかどうかは、コードすらない段階で第三者には分かりません。

そのまま動くサンプルコードを貼りつつ、目的などを説明/共有した方がいいと思います。

Answer 1

YAmaGNZさん 2020/08/05 23:24 のコメントのざっくり実装です。

同様のものを作るのは大変なので、以下のように置き換えさせていただきます。
ユーザーコントロール → Form1（Form）
SplitContainerを拡張したコンポーネント → ParentPanel（FlowLayoutPanel）
SplitterPanelを拡張したコンポーネント → ChildPanel（Panel）

ChildPanelの追加・削除時にイベント登録・解除して、新しく作った専用のイベントにまわすだけです。
本題に関係ないコードのほうが多いですが、ポイントはコメントが入ってる部分だけです。

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Drawing;
using System.Linq;
using System.Windows.Forms;

namespace Questions282825
{
    public partial class Form1 : Form
    {
        private ParentPanel parentPanel;
        private ListBox listBox;

        public Form1()
        {
            InitializeComponent();

            parentPanel = new ParentPanel() { Dock = DockStyle.Fill, };

            // 子供クリックイベントの登録
            parentPanel.ChildClick += ParentPanel_ChildClick;
            Controls.Add(parentPanel);

            var addButton = new Button { Dock = DockStyle.Bottom, Text = "add", };
            addButton.Click += AddButton_Click;

            var clearButton = new Button { Dock = DockStyle.Top, Text = "clear", };
            clearButton.Click += ClearButton_Click;

            var tableLayoutPanel = new TableLayoutPanel { Dock = DockStyle.Left, Width = 80, };
            tableLayoutPanel.Controls.Add(addButton, 0, 0);
            tableLayoutPanel.Controls.Add(clearButton, 0, 1);
            tableLayoutPanel.RowStyles.Add(new RowStyle(SizeType.Percent, 50F));
            tableLayoutPanel.RowStyles.Add(new RowStyle(SizeType.Percent, 50F));
            Controls.Add(tableLayoutPanel);

            listBox = new ListBox { Dock = DockStyle.Left, SelectionMode = SelectionMode.MultiSimple, };
            listBox.DataSource = new Color[] { Color.Red, Color.Green, Color.Blue, };
            Controls.Add(listBox);
        }

        private void ParentPanel_ChildClick(object sender, EventArgs e)
        {
            if(sender is Control control)
            {
                Debug.WriteLine($"{control.Name} {control.BackColor}");
            }
        }

        private void AddButton_Click(object sender, EventArgs e)
        {
            var colors = listBox.SelectedItems.Cast<Color>();
            parentPanel.AddRange(colors);
        }

        private void ClearButton_Click(object sender, EventArgs e)
        {
            parentPanel.Clear();
        }


        class ParentPanel : FlowLayoutPanel
        {
            // 新しく作った子供クリックイベント
            public event EventHandler ChildClick;

            public void AddRange(IEnumerable<Color> colors)
            {
                foreach(var color in colors)
                {
                    var child = new ChildPanel(color);

                    // 追加時にイベント登録
                    child.Click += Child_Click;
                    Controls.Add(child);
                }
            }

            public void Clear()
            {
                foreach(var child in Controls.Cast<Control>().ToArray())
                {
                    // 削除時にイベント解除
                    child.Click -= Child_Click;
                    Controls.Remove(child);
                    child.Dispose();
                }
            }

            private void Child_Click(object sender, EventArgs e)
            {
                // 子供クリックイベントを発砲（sender e そのまま渡しは雑い^^;
                ChildClick?.Invoke(sender, e);
            }
        }

        class ChildPanel : Panel
        {
            private static int i;

            public ChildPanel(Color color)
            {
                Name = $"Panel{++i}";
                Width = 100;
                Height = 100;
                BackColor = color;
            }
        }
    }
}

そのたびにSplitterPanelに対してイベントを付与する必要

もしかして「やれるのはわかっているが、いちいち登録解除がめんどくさい」って意味でしょうか？

こんなソリューションがありました（この要件だとオーバーすぎる気がしますが）
Broadcasting Events through a Control Hierarchy - CodeProject
たしか無料登録しないとダウンロードできなかったと思うので、面倒な場合こちら（おそらく↑そのまま）
POSTSTAR/EventBroadcastProvider.cs at master · ohintaek/POSTSTAR

最初読み違えてSplitContainerを多段に入れ子すると思っていたので、そんな作りになってしまっています^^;

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Drawing;
using System.Linq;
using System.Windows.Forms;

namespace Questions282825
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();

            var splitContainer = new MySplitContainer();
            Controls.Add(splitContainer);

            // どちらにしろこれは必須
            var broadcastProvider = EventBroadcastProvider.CreateProvider(splitContainer, "Click");

            // 単にクリックが拾えればいい場合
            splitContainer.Click += SplitContainer_Click;

            // クリックされたコントロールやツリーも欲しい場合
            broadcastProvider.Relayed += BroadcastProvider_Relayed;
        }

        private void SplitContainer_Click(object sender, EventArgs e)
        {
            Debug.WriteLine("Click");
        }

        private void BroadcastProvider_Relayed(object sender, RelayedEventArgs e)
        {
            if(e.RelayChain[0] is Control control)
            {
                Debug.WriteLine($"{control.Name} {control.BackColor}");
            }
        }


        // 本題には関係ないが検証用に雑に作成
        class MySplitContainer : SplitContainer
        {
            private static List<KnownColor> colors;
            private static Random random = new Random();
            private static int i;

            private static ContextMenuStrip contextMenuStrip;
            private static ToolStripMenuItem addToolStripMenuItem;
            private static ToolStripMenuItem delToolStripMenuItem;

            static MySplitContainer()
            {
                colors = Enum.GetValues(typeof(KnownColor)).Cast<KnownColor>().ToList();

                addToolStripMenuItem = new ToolStripMenuItem { Text = "追加", };
                addToolStripMenuItem.Click += AddToolStripMenuItem_Click;

                delToolStripMenuItem = new ToolStripMenuItem { Text = "削除", };
                delToolStripMenuItem.Click += DelToolStripMenuItem_Click;

                contextMenuStrip = new ContextMenuStrip();
                contextMenuStrip.Items.Add(addToolStripMenuItem);
                contextMenuStrip.Items.Add(delToolStripMenuItem);
            }

            public MySplitContainer()
            {
                BorderStyle = BorderStyle.Fixed3D;
                Dock = DockStyle.Fill;

                Panel1.Name = $"Panel{++i}";
                Panel2.Name = $"Panel{++i}";

                Panel1.ContextMenuStrip = contextMenuStrip;
                Panel2.ContextMenuStrip = contextMenuStrip;

                Panel1.BackColor = Color.FromKnownColor(colors.Skip(random.Next(0, colors.Count)).First());
                Panel2.BackColor = Color.FromKnownColor(colors.Skip(random.Next(0, colors.Count)).First());
            }

            private static void AddToolStripMenuItem_Click(object sender, EventArgs e)
            {
                if(sender is ToolStripItem item)
                {
                    if(item.Owner is ContextMenuStrip menuStrip)
                    {
                        if(menuStrip.SourceControl is SplitterPanel panel)
                        {
                            var o = (int)Orientation.Vertical;
                            if(panel.Parent is SplitContainer container)
                            {
                                o = (int)container.Orientation;
                                o ^= 1;
                            }

                            var sc = new MySplitContainer { Orientation = (Orientation)o };
                            panel.Controls.Add(sc);
                        }
                    }
                }
            }

            private static void DelToolStripMenuItem_Click(object sender, EventArgs e)
            {
                if(sender is ToolStripItem item)
                {
                    if(item.Owner is ContextMenuStrip menuStrip)
                    {
                        if(menuStrip.SourceControl is SplitterPanel panel)
                        {
                            if(panel.Parent is SplitContainer container)
                            {
                                container.Parent.Controls.Remove(container);
                                container.Dispose();
                            }
                        }
                    }
                }
            }
        }
    }
}