WinForms アプリケーションにおける UserControl を活用したオブジェクト指向入門

以下に、前回のサンプルを拡張して、以下の３点について模範解答例を示します。

• カスタムプロパティの追加:
  UserControl の見た目に関するプロパティ（背景色、フォントサイズ、クリック閾値）を外部から設定できるように実装します。
• イベントの公開:
  UserControl 内でクリック回数が一定数に達した際にイベントを発行し、フォーム側でそのイベントをハンドリングする実装例です。
• 複数の UserControl の配置:
  フォーム上に複数の MyUserControl を配置し、それぞれ独立した状態管理とイベントハンドリングができる例を示します。

以下は各機能を盛り込んだ模範解答例となります。

1. MyUserControl の拡張

1.1. 拡張内容

• カスタムプロパティ
  • CustomBackColor: UserControl 全体の背景色を外部から変更できるようにするプロパティ。
  • LabelFontSize: 内部の Label のフォントサイズを設定できるプロパティ。
  • ClickThreshold: クリック回数の閾値。指定回数に達したときにイベントを発行します。
• イベントの公開
  • ThresholdReached: クリック回数が設定された閾値に達したときに発生するイベント。
    ※ 発生条件は「クリック回数 == ClickThreshold」
    ※ 発生時にはフォーム側へ通知します。

1.2. サンプルコード

using System;
using System.Drawing;
using System.Windows.Forms;

namespace UserControlTutorial
{
    public partial class MyUserControl : UserControl
    {
        // 内部状態: クリック回数と閾値
        private int clickCount = 0;
        private int clickThreshold = 5; // 初期閾値（外部から変更可能）

        // 閾値に達したときに発生するイベント
        public event EventHandler ThresholdReached;

        public MyUserControl()
        {
            InitializeComponent();
        }

        // ボタンのクリックイベントハンドラー
        private void button1_Click(object sender, EventArgs e)
        {
            clickCount++;
            label1.Text = $"クリック回数: {clickCount}";

            // クリック回数が閾値に達した場合、イベントを発行
            if (clickCount == clickThreshold)
            {
                OnThresholdReached(EventArgs.Empty);
            }
        }

        // イベント発行用の保護メソッド（継承先でオーバーライド可能）
        protected virtual void OnThresholdReached(EventArgs e)
        {
            ThresholdReached?.Invoke(this, e);
        }

        // ※ 既存のプロパティ ※
        public string LabelText
        {
            get { return label1.Text; }
            set { label1.Text = value; }
        }

        // ■ カスタムプロパティの追加 ■

        /// <summary>
        /// UserControl 全体の背景色を取得・設定します。
        /// </summary>
        public Color CustomBackColor
        {
            get { return this.BackColor; }
            set { this.BackColor = value; }
        }

        /// <summary>
        /// 内部 Label のフォントサイズを取得・設定します。
        /// </summary>
        public float LabelFontSize
        {
            get { return label1.Font.Size; }
            set
            {
                // 現在のフォントファミリーとスタイルを維持しながらサイズを変更
                label1.Font = new Font(label1.Font.FontFamily, value, label1.Font.Style);
            }
        }

        /// <summary>
        /// クリック回数の閾値を取得・設定します。
        /// </summary>
        public int ClickThreshold
        {
            get { return clickThreshold; }
            set { clickThreshold = value; }
        }
    }
}

1.3. 補足

• デザイナーでの設定:
  上記プロパティはデザイナー上では直接表示されない場合もあります。プロパティウィンドウで変更できるようにする場合は、必要に応じて Browsable や Category 属性を追加すると良いでしょう。
• イベント発行のタイミング:
  ここではクリック回数が「ClickThreshold」に達したときにイベントを発行しています。必要に応じて条件を変更してください。

2. メインフォーム (Form1) における複数の MyUserControl の配置とイベントハンドリング

2.1. 配置内容

フォーム上に複数の MyUserControl（例: myUserControl1、myUserControl2）を配置し、それぞれに対して以下の操作を行います。

• カスタムプロパティの設定
  （例: 背景色、フォントサイズ、クリック閾値を個別に設定）
• イベントハンドラーの登録
  （各コントロールの ThresholdReached イベントをフォーム側で受け取り、どのコントロールからイベントが発生したかを判別する）

2.2. サンプルコード（Form1.cs）

using System;
using System.Drawing;
using System.Windows.Forms;

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

            // フォーム上に配置済みの MyUserControl インスタンスに対してイベントハンドラーを登録
            myUserControl1.ThresholdReached += MyUserControl_ThresholdReached;
            myUserControl2.ThresholdReached += MyUserControl_ThresholdReached;

            // 個別にカスタムプロパティを設定
            // myUserControl1 の設定
            myUserControl1.CustomBackColor = Color.LightBlue;
            myUserControl1.LabelFontSize = 12f;
            myUserControl1.ClickThreshold = 3;  // 3クリックでイベント発生

            // myUserControl2 の設定
            myUserControl2.CustomBackColor = Color.LightGreen;
            myUserControl2.LabelFontSize = 14f;
            myUserControl2.ClickThreshold = 5;  // 5クリックでイベント発生
        }

        // 共通のイベントハンドラー
        private void MyUserControl_ThresholdReached(object sender, EventArgs e)
        {
            MyUserControl control = sender as MyUserControl;
            if (control != null)
            {
                MessageBox.Show($"{control.Name} のクリック回数が設定された閾値に達しました！", "Threshold Reached");
            }
        }
    }
}

2.3. 補足

• 複数インスタンスの独立性:
  それぞれの MyUserControl は独立した内部状態（クリック回数、カスタムプロパティ）を持つため、フォーム上に複数配置しても干渉せずに動作します。
• イベントハンドラー内での判別:
  sender パラメータを利用することで、どのコントロールからイベントが発生したのかを判別できます。ここでは control.Name を利用していますが、任意の識別子（例えば Tag プロパティなど）を利用しても良いでしょう。

3. まとめ

今回の模範解答では、以下の点を実装しました。

1. カスタムプロパティの追加:
   • 背景色（CustomBackColor）とラベルのフォントサイズ（LabelFontSize）の設定を外部から可能にしました。
   • また、クリック閾値（ClickThreshold）もプロパティとして公開し、動作条件を柔軟に変更できるようにしました。
2. イベントの公開:
   • クリック回数が閾値に達した場合に、ThresholdReached イベントを発行し、フォーム側でハンドリングする仕組みを実装しました。
3. 複数の UserControl の配置:
   • フォーム上に複数の MyUserControl を配置し、各コントロールごとにカスタムプロパティの設定やイベントハンドラーの登録を行うことで、各インスタンスが独立して動作する例を示しました。

これらの実装を通じて、UserControl の拡張方法、オブジェクト指向のカプセル化・継承の活用、そしてイベント駆動型プログラミングの基本が学べます。ぜひ、各機能をさらに改良して、より高度なアプリケーション開発に挑戦してください。