チュートリアル: C を使用して複合コントロールを作成する#

複合コントロールは、カスタムグラフィカルインターフェイスを作成および再利用するための手段を提供します。複合コントロールは、基本的に視覚的表現を持つコンポーネントです。そのため、ユーザー入力の検証、表示プロパティの変更、または作成者が必要とするその他のタスクの実行によって機能を拡張できる 1 つ以上の Windows フォームコントロール、コンポーネント、またはコードブロックで構成される場合があります。複合コントロールは、他のコントロールと同じ方法で Windows フォームに配置できます。このチュートリアルの最初の部分では、 ctlClockと呼ばれる単純な複合コントロールを作成します。チュートリアルの 2 番目の部分では、継承によって ctlClock の機能を拡張します。

プロジェクトの作成

新しいプロジェクトを作成するときは、その名前を指定してルート名前空間、アセンブリ名、プロジェクト名を設定し、既定のコンポーネントが正しい名前空間にあることを確認します。

ctlClockLib コントロールライブラリと ctlClock コントロールを作成するには

Visual Studio で、新しい Windows フォームコントロールライブラリプロジェクトを 作成し、 ctlClockLib という名前を付けます。

プロジェクト名 ctlClockLibは、既定でルート名前空間にも割り当てられます。ルート名前空間は、アセンブリ内のコンポーネントの名前を修飾するために使用されます。たとえば、2 つのアセンブリに ctlClock という名前のコンポーネントが用意されている場合は、次を使用して ctlClock コンポーネントを指定できます。 ctlClockLib.ctlClock.
ソリューションエクスプローラーで、UserControl1.csを右クリックし、[名前の変更] をクリックします。ファイル名を ctlClock.cs に変更します。コード要素 "UserControl1" へのすべての参照の名前を変更するかどうかを確認するメッセージが表示されたら、[ はい ] ボタンをクリックします。

注

既定では、複合コントロールはシステムによって提供される UserControl クラスから継承されます。 UserControl クラスは、すべての複合コントロールに必要な機能を提供し、標準のメソッドとプロパティを実装します。
[ ファイル ] メニューの [ すべて保存 ] をクリックしてプロジェクトを保存します。

複合コントロールに Windows コントロールとコンポーネントを追加する

ビジュアルインターフェイスは、複合コントロールの重要な部分です。このビジュアルインターフェイスは、1 つ以上の Windows コントロールをデザイナー画面に追加することによって実装されます。次のデモでは、Windows コントロールを複合コントロールに組み込み、機能を実装するコードを記述します。

複合コントロールにラベルとタイマーを追加するには

ソリューションエクスプローラーで、ctlClock.csを右クリックし、[デザイナーの表示] をクリックします。
ツールボックスで、[共通コントロール] ノードを展開し、[ラベル] をダブルクリックします。

Labelという名前のlabel1 コントロールがデザイナー画面のコントロールに追加されます。
デザイナーで label1 をクリックします。 [プロパティ] ウィンドウで、次のプロパティを設定します。

プロパティ変更後の値

名前 lblDisplay

テキスト (blank space)

TextAlign MiddleCenter

Font.Size 14
ツールボックスで、[コンポーネント] ノードを展開し、[タイマー] をダブルクリックします。

Timerはコンポーネントであるため、実行時に視覚的な表現はありません。したがって、デザイナー画面のコントロールではなく、 コンポーネントデザイナー (デザイナー 画面の下部にあるトレイ) に表示されます。
コンポーネントデザイナーで、timer1 をクリックし、Interval プロパティを 1000 に設定し、Enabled プロパティを true に設定します。

Interval プロパティは、Timerコンポーネントがティックする頻度を制御します。 timer1 がティックするたびに、timer1_Tick イベント内でコードが実行されます。間隔は、ティック間のミリ秒数を表します。
コンポーネントデザイナーで、timer1 をダブルクリックして、timer1_TickのctlClock イベントに移動します。
次のコードサンプルに似せてコードを修正してください。アクセス修飾子は必ず private から protected に変更してください。
```
protected void timer1_Tick(object sender, System.EventArgs e)
{
    // Causes the label to display the current time.
    lblDisplay.Text = DateTime.Now.ToLongTimeString();
}
```
このコードにより、現在の時刻が lblDisplayに表示されます。 timer1の間隔は 1000 に設定されているため、このイベントは 1000 ミリ秒ごとに発生するため、現在の時刻が 1 秒ごとに更新されます。
virtual キーワードでオーバーライドできるようにメソッドを変更します。詳細については、以下の「ユーザーコントロールからの継承」セクションを参照してください。
```
protected virtual void timer1_Tick(object sender, System.EventArgs e)
```
[ ファイル ] メニューの [ すべて保存 ] をクリックしてプロジェクトを保存します。

プロパティ	変更後の値
名前	`lblDisplay`
テキスト	`(blank space)`
TextAlign	`MiddleCenter`
Font.Size	`14`

複合コントロールにプロパティを追加する

クロックコントロールは、 Label コントロールと Timer コンポーネントをカプセル化し、それぞれに固有のプロパティのセットを持つようになりました。これらのコントロールの個々のプロパティには、コントロールの後続のユーザーがアクセスすることはできませんが、適切なコードブロックを記述することで、カスタムプロパティを作成して公開できます。次の手順では、ユーザーが背景とテキストの色を変更できるようにするプロパティをコントロールに追加します。

複合コントロールにプロパティを追加するには

ソリューションエクスプローラーで、ctlClock.csを右クリックし、[コードの表示] をクリックします。

コントロールの コードエディター が開きます。
public partial class ctlClock ステートメントを見つけます。左中かっこ ({)の下に、次のコードを入力します。
```
private Color colFColor;
private Color colBColor;
```
これらのステートメントは、作成しようとしているプロパティの値を格納するために使用するプライベート変数を作成します。

手順 2 の変数宣言の下に、次のコードを入力するか貼り付けます。

// Declares the name and type of the property.
public Color ClockBackColor
{
    // Retrieves the value of the private variable colBColor.
    get
    {
        return colBColor;
    }
    // Stores the selected value in the private variable colBColor, and
    // updates the background color of the label control lblDisplay.
    set
    {
        colBColor = value;
        lblDisplay.BackColor = colBColor;
    }
}
// Provides a similar set of instructions for the foreground color.
public Color ClockForeColor
{
    get
    {
        return colFColor;
    }
    set
    {
        colFColor = value;
        lblDisplay.ForeColor = colFColor;
    }
}

上記のコードでは、 ClockForeColor と ClockBackColorの 2 つのカスタムプロパティを、このコントロールの後続のユーザーが使用できるようにします。 getステートメントとset ステートメントは、プロパティ値の格納と取得、およびプロパティに適した機能を実装するコードを提供します。

[ ファイル ] メニューの [ すべて保存 ] をクリックしてプロジェクトを保存します。

コントロールをテストする

コントロールはスタンドアロンアプリケーションではありません。これらはコンテナーでホストされている必要があります。 UserControl テストコンテナーを使用して、コントロールの実行時の動作をテストし、そのプロパティを実行します。詳細については、「方法: UserControlの Run-Time 動作をテストする」を参照してください。

コントロールをテストするには

F5 キーを押してプロジェクトをビルドし、UserControl テストコンテナーでコントロールを実行します。
テストコンテナーのプロパティグリッドで、 ClockBackColor プロパティを見つけ、プロパティを選択してカラーパレットを表示します。
色をクリックして選択します。

コントロールの背景色は、選択した色に変わります。
同様の一連のイベントを使用して、 ClockForeColor プロパティが期待どおりに機能していることを確認します。

このセクションと前のセクションでは、コンポーネントと Windows コントロールをコードとパッケージ化と組み合わせて、複合コントロールの形式でカスタム機能を提供する方法について説明しました。複合コントロールのプロパティを公開する方法と、コントロールが完了した後でコントロールをテストする方法について学習しました。次のセクションでは、 ctlClock をベースとして使用して継承された複合コントロールを構築する方法について説明します。

複合コントロールから継承する

前のセクションでは、Windows コントロール、コンポーネント、コードを再利用可能な複合コントロールに結合する方法について説明しました。複合コントロールを、他のコントロールを構築できるベースとして使用できるようになりました。基底クラスからクラスを派生させるプロセスは、継承と呼ばれます。このセクションでは、 ctlAlarmClockという複合コントロールを作成します。このコントロールは、親コントロール ( ctlClock) から派生します。親メソッドをオーバーライドし、新しいメソッドとプロパティを追加することで、 ctlClock の機能を拡張する方法について説明します。

継承されたコントロールを作成する最初の手順は、その親から派生することです。このアクションにより、親コントロールのすべてのプロパティ、メソッド、およびグラフィカル特性を持つ新しいコントロールが作成されますが、新しい機能や変更された機能を追加するためのベースとして機能することもできます。

継承されたコントロールを作成するには

ソリューションエクスプローラーでctlClockLib を右クリックし、[追加] をポイントして、[ユーザーコントロール] をクリックします。

[新しい項目の追加] ダイアログボックスが開きます。
[継承されたユーザーコントロール] テンプレートを選択します。
[ 名前 ] ボックスに「 ctlAlarmClock.cs」と入力し、[ 追加] をクリックします。

[ 継承ピッカー ] ダイアログボックスが表示されます。
[ コンポーネント名]で、 ctlClock をダブルクリックします。
ソリューションエクスプローラーで、現在のプロジェクトを参照します。

注

ctlAlarmClock.csというファイルが現在のプロジェクトに追加されました。

アラームのプロパティを追加する

プロパティは、複合コントロールに追加されるのと同じ方法で、継承されたコントロールに追加されます。次に、プロパティ宣言構文を使用して、アラームがオフになる日時の値を格納する AlarmTime と、アラームが設定されているかどうかを示す AlarmSet の 2 つのプロパティをコントロールに追加します。

複合コントロールにプロパティを追加するには

ソリューションエクスプローラーで、ctlAlarmClock を右クリックし、[コードの表示] をクリックします。

public class ステートメントを見つけます。コントロールは ctlClockLib.ctlClockから継承されることに注意してください。開き中かっこ（{) ステートメント）内に、次のコードを入力します。

private DateTime dteAlarmTime;
private bool blnAlarmSet;
// These properties will be declared as public to allow future
// developers to access them.
public DateTime AlarmTime
{
    get
    {
        return dteAlarmTime;
    }
    set
    {
        dteAlarmTime = value;
    }
}
public bool AlarmSet
{
    get
    {
        return blnAlarmSet;
    }
    set
    {
        blnAlarmSet = value;
    }
}

コントロールのグラフィカルインターフェイスに追加する

継承されたコントロールには、継承するコントロールと同じビジュアルインターフェイスがあります。親コントロールと同じ構成コントロールを所有していますが、特に公開されていない限り、構成コントロールのプロパティは使用できません。複合コントロールに追加するのと同じ方法で、継承された複合コントロールのグラフィカルインターフェイスに追加できます。アラームクロックのビジュアルインターフェイスに追加を続けるには、アラームが鳴ったときに点滅するラベルコントロールを追加します。

ラベルコントロールを追加するには

ソリューションエクスプローラーで、ctlAlarmClock を右クリックし、[デザイナーの表示] をクリックします。

メインウィンドウに ctlAlarmClock のデザイナーが開きます。
コントロールの表示部分をクリックし、[プロパティ] ウィンドウを表示します。

注

すべてのプロパティが表示されている間は、淡色表示されます。これは、これらのプロパティが lblDisplay ネイティブであり、[プロパティ] ウィンドウで変更またはアクセスできないことを示します。既定では、複合コントロールに含まれるコントロールは privateされ、プロパティにはアクセスできません。

注

複合コントロールの後続のユーザーがその内部コントロールにアクセスできるようにする場合は、 public または protectedとして宣言します。これにより、適切なコードを使用して、複合コントロールに含まれるコントロールのプロパティを設定および変更できます。
複合コントロールに Label コントロールを追加します。
マウスを使用して、 Label コントロールを表示ボックスのすぐ下にドラッグします。 [プロパティ] ウィンドウで、次のプロパティを設定します。

プロパティ設定

名前 lblAlarm

テキスト 警報！

TextAlign MiddleCenter

表示 false

プロパティ	設定
名前	`lblAlarm`
テキスト	警報！
TextAlign	`MiddleCenter`
表示	`false`

アラーム機能を追加する

前の手順では、複合コントロールでアラーム機能を有効にするプロパティとコントロールを追加しました。この手順では、現在の時刻とアラーム時刻を比較し、同じ場合にアラームをフラッシュするコードを追加します。 timer1_TickのctlClockメソッドをオーバーライドし、コードを追加することで、ctlAlarmClock固有のすべての機能を保持しながら、ctlClockの機能を拡張します。

ctlClock の timer1_Tick メソッドをオーバーライドするには

コードエディターで、private bool blnAlarmSet; ステートメントを見つけます。その直下に、次のステートメントを追加します。
```
private bool blnColorTicker;
```

コードエディターで、クラス定義の最後にある閉じ中括弧 (}) を見つけます。中かっこの直前に次のコードを追加してください。

protected override void timer1_Tick(object sender, System.EventArgs e)
{
    // Calls the Timer1_Tick method of ctlClock.
    base.timer1_Tick(sender, e);
    // Checks to see if the alarm is set.
    if (AlarmSet == false)
        return;
    else
        // If the date, hour, and minute of the alarm time are the same as
        // the current time, flash an alarm.
    {
        if (AlarmTime.Date == DateTime.Now.Date && AlarmTime.Hour ==
            DateTime.Now.Hour && AlarmTime.Minute == DateTime.Now.Minute)
        {
            // Sets lblAlarmVisible to true, and changes the background color based on
            // the value of blnColorTicker. The background color of the label
            // will flash once per tick of the clock.
            lblAlarm.Visible = true;
            if (blnColorTicker == false)
            {
                lblAlarm.BackColor = Color.Red;
                blnColorTicker = true;
            }
            else
            {
                lblAlarm.BackColor = Color.Blue;
                blnColorTicker = false;
            }
        }
        else
        {
            // Once the alarm has sounded for a minute, the label is made
            // invisible again.
            lblAlarm.Visible = false;
        }
    }
}

このコードを追加すると、いくつかのタスクが実行されます。 override ステートメントは、基本コントロールから継承されたメソッドの代わりにこのメソッドを使用するようにコントロールに指示します。このメソッドが呼び出されると、 base.timer1_Tick ステートメントを呼び出してオーバーライドするメソッドが呼び出され、元のコントロールに組み込まれているすべての機能がこのコントロールに再現されます。その後、アラーム機能を組み込むために追加のコードを実行します。アラームが発生すると、点滅するラベルコントロールが表示されます。

目覚まし時計の制御はほぼ完了です。残っているのは、オフにする方法を実装することだけです。これを行うには、 lblAlarm_Click メソッドにコードを追加します。

シャットオフメソッドを実装するには

ソリューションエクスプローラーで、ctlAlarmClock.csを右クリックし、[デザイナーの表示] をクリックします。

デザイナーが開きます。
コントロールにボタンを追加します。ボタンのプロパティを次のように設定します。

プロパティ価値

名前 btnAlarmOff

テキスト アラームを無効にする
デザイナーで、 btnAlarmOff をダブルクリックします。

コードエディターが開き、private void btnAlarmOff_Click行が表示されます。

プロパティ	価値
名前	`btnAlarmOff`
テキスト	アラームを無効にする

次のコードのように、このメソッドを変更します。

private void btnAlarmOff_Click(object sender, System.EventArgs e)
{
    // Turns off the alarm.
    AlarmSet = false;
    // Hides the flashing label.
    lblAlarm.Visible = false;
}

[ ファイル ] メニューの [ すべて保存 ] をクリックしてプロジェクトを保存します。

フォームで継承されたコントロールを使用する

基本クラスコントロールをテストしたのと同じ方法で、継承したコントロールをテストできます。 ctlClock: F5 キーを押してプロジェクトをビルドし、 UserControl テストコンテナーでコントロールを実行します。詳細については、「方法: UserControlの Run-Time 動作をテストする」を参照してください。

使用するコントロールを配置するには、フォームでホストする必要があります。標準の複合コントロールと同様に、継承された複合コントロールは単独では使用できず、フォームまたはその他のコンテナーでホストする必要があります。 ctlAlarmClockの機能の詳細が増えるので、それをテストするには追加のコードが必要です。この手順では、 ctlAlarmClockの機能をテストする簡単なプログラムを記述します。 AlarmTimeのctlAlarmClock プロパティを設定して表示するコードを記述し、その固有の関数をテストします。

コントロールをビルドしてテストフォームに追加するには

ソリューションエクスプローラーでctlClockLib を右クリックし、[ビルド] をクリックします。
ソリューションに新しい Windows フォームアプリケーション プロジェクトを追加し、Test という名前を付 けます。
ソリューションエクスプローラーで、テストプロジェクトの [参照] ノードを右クリックします。 [ 参照の追加] をクリックして、[ 参照の追加 ] ダイアログボックスを表示します。 [ プロジェクト] というラベルの付いたタブをクリックします。 ctlClockLib プロジェクトがプロジェクト名の下に表示されます。プロジェクトをダブルクリックして、テストプロジェクトへの参照を追加します。
ソリューションエクスプローラーで、[テスト] を右クリックし、[ビルド] をクリックします。
ツールボックスで、ctlClockLib コンポーネント ノードを展開します。
ctlAlarmClock をダブルクリックして、ctlAlarmClockのコピーをフォームに追加します。
ツールボックスで DateTimePicker を見つけてダブルクリックし、フォームにDateTimePicker コントロールを追加し、[Label] をダブルクリックしてコントロールを追加します。
マウスを使用して、フォーム上の便利な場所にコントロールを配置します。

これらのコントロールのプロパティは、次のように設定します。

コントロール	プロパティ	価値
`label1`	テキスト	`(blank space)`
	名前	`lblTest`
`dateTimePicker1`	名前	`dtpTest`
	形式	Time

デザイナーで、 dtpTest をダブルクリックします。

コードエディターがprivate void dtpTest_ValueChangedに開きます。

次のようにコードを変更します。

private void dtpTest_ValueChanged(object sender, System.EventArgs e)
{
    ctlAlarmClock1.AlarmTime = dtpTest.Value;
    ctlAlarmClock1.AlarmSet = true;
    lblTest.Text = "Alarm Time is " +
        ctlAlarmClock1.AlarmTime.ToShortTimeString();
}

ソリューションエクスプローラーで、[テスト] を右クリックし、[スタートアッププロジェクトとして設定] をクリックします。
[デバッグ] メニューの [デバッグの開始] をクリックします。

テストプログラムが開始されます。 ctlAlarmClock コントロールで現在の時刻が更新され、開始時刻が DateTimePicker コントロールに表示されることに注意してください。
時間の分が表示される DateTimePicker をクリックします。
キーボードを使用して、 ctlAlarmClockで表示されている現在の時刻より 1 分大きい分の値を設定します。

アラーム設定の時間が lblTestに表示されます。表示された時刻がアラーム設定時間に達するまで待ちます。アラームが設定された時刻に達すると、 lblAlarm が点滅します。
btnAlarmOffをクリックしてアラームをオフにします。アラームをリセットできるようになりました。

この記事では、いくつかの主要な概念について説明しました。コントロールとコンポーネントを複合コントロールコンテナーに組み合わせて複合コントロールを作成する方法について学習しました。コントロールにプロパティを追加し、カスタム機能を実装するコードを記述する方法について学習しました。最後のセクションでは、継承によって特定の複合コントロールの機能を拡張し、それらのメソッドをオーバーライドしてホストメソッドの機能を変更する方法について学習しました。

こちらも参照ください

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-05-07

次の方法で共有

チュートリアル: C を使用して複合コントロールを作成する#

プロジェクトの作成

ctlClockLib コントロール ライブラリと ctlClock コントロールを作成するには

複合コントロールに Windows コントロールとコンポーネントを追加する

複合コントロールにラベルとタイマーを追加するには

複合コントロールにプロパティを追加する

複合コントロールにプロパティを追加するには

コントロールをテストする

コントロールをテストするには

複合コントロールから継承する

継承されたコントロールを作成するには

アラームのプロパティを追加する

複合コントロールにプロパティを追加するには

コントロールのグラフィカル インターフェイスに追加する

ラベル コントロールを追加するには

アラーム機能を追加する

ctlClock の timer1_Tick メソッドをオーバーライドするには

シャットオフ メソッドを実装するには

フォームで継承されたコントロールを使用する

コントロールをビルドしてテスト フォームに追加するには

こちらも参照ください

フィードバック

その他のリソース

ctlClockLib コントロールライブラリと ctlClock コントロールを作成するには

コントロールのグラフィカルインターフェイスに追加する

ラベルコントロールを追加するには

シャットオフメソッドを実装するには

コントロールをビルドしてテストフォームに追加するには