ユーザーコントロールを極めよう

2023年11月7日

当ページのリンクには広告が含まれています。

ユーザーコントロールとは、複数のコントロールを組み合わせて作ったコントロールのことです。

例えばファイルを選択する場合、テキストボックスとダイアログ表示ボタンを並べる事がよくあります。

例えば画面から10個のファイルが選択できるようなプログラムだと、テキストボックスとダイアログ表示ボタンを10組画面に配置しなければなりません。

また、それぞれに対して同じ処理を記述していく必要もあります。

このような場合、テキストボックスとダイアログ表示ボタンが１つのコントロールに出来れば便利ですよね。

エクセルやパワーポイントで図形を作成する際、グルーピングという機能を使うと思いますが、ユーザーコントロールはこれに相当します。

空のユーザーコントロールを作る

ユーザーコントロールは自分の好きなコントロールをグルーピングするものなので、際初は空のユーザーコントロールが出来上がります。

ソリューションエクスプローラーからプロジェクトをクリックし、表示されるメニューから「追加」をクリック、更に表示されるメニューから「ユーザーコントロール(Windowフォーム）」をクリックします。

「新しい項目の追加」ウィンドウが表示されるので、ユーザーコントロール(Windowsフォーム）が選択されている（反転している）ことを確認し、ウィンドウ下の名前から任意のユーザーコントロール名を入力します。

名前については、ユーザーコントロールを示す uct という接頭語を付ける人もいますし、末尾に UserControlを付加する人もいます。

この辺は好みによりますが、ソースコード上でユーザーコントロールだと判断できる方が良いかもしれません。

参考までに動画を掲載しておきます。

この例では、MyUserControlという名前でユーザーコントロールを作成しています。

好きなコントロールを配置する

空のユーザーコントロールを作ったら、後は好きなコントロールを置いていきます。

通常のWindowフォームと同じ様に、左のツールボックスからドラッグ＆ドロップで張り付けてください。

張り付ける個数の制限は特にありませんが、あまりたくさん張り付けるとソースコード量が増えてメンテナンスがやり難くなるなどの弊害も発生します。

実際の操作については下記の動画をご覧ください。

ユーザーコントロールはWindowフォームと同じ

コントロールを配置して、イベントハンドラを作って、イベントに応じて処理を記述するという作業は普通のWindowフォームと同じです。

張り付けたコントロールをダブルクリックすると、コントロールに応じたイベントハンドラが自動生成されます。

また、必要に応じて右側のプロパティから任意のプロパティに値を設定したり、イベントハンドラを追加していきます。

あとは、イベントハンドラに応じて処理を記述していくだけです。

ここまでの操作は以下の動画でご確認下さい。

プロパティとメソッドを追加する

ユーザーコントロールは外部に対してプロパティやメソッドを公開出来ます。

その方法は公開したいプロパティやメソッドにPublicを付けるだけです。

   public partial class SampleUserControl: UserControl
    {
        //プロパティのサンプル
        public bool HiSpeedMode { get; set; } = false;
        public string FileName { get { return uxFileName.Text; } set { uxFileName.Text = value; } }
        
        //コンストラクタ
        public FileSelectUserControl()
        {
            InitializeComponent();
        }
        /// <summary>
        /// メソッドのサンプル
        /// </summary>
        public void Clear()
        {
            uxFileName.Text = "";
        }
　   }
}