チュートリアル: 複合データバインドをサポートする Windows フォームユーザーコントロールの作成

[アーティクル]
02/09/2017

公開日: 2016年4月

Windows アプリケーションのフォームにデータを表示する場合は、[ツールボックス] から既存のコントロールを選択するか、またはアプリケーションが標準コントロールでは提供できない機能を必要とする場合は、カスタムコントロールを記述できます。このチュートリアルでは、ComplexBindingPropertiesAttribute を実装するコントロールを作成する方法を示します。 ComplexBindingPropertiesAttribute を実装するコントロールには、データにバインドできる DataSource プロパティと DataMember プロパティが含まれます。このようなコントロールは、DataGridView や ListBox に似ています。

コントロールの作成の詳細については、「デザイン時の Windows フォームコントロールの開発」を参照してください。

データバインディングのシナリオで使用するためのコントロールを作成するときは、次のいずれかのデータバインド属性を実装する必要があります。

データバインド属性の使用
単一のデータ列またはプロパティを表示する TextBox のような DefaultBindingPropertyAttribute を簡単なコントロールに実装します。詳細については、「チュートリアル: 単純データバインドをサポートする Windows フォームユーザーコントロールの作成」を参照してください。
データの一覧またはテーブルを表示する DataGridView のような ComplexBindingPropertiesAttribute をコントロールに実装します。このチュートリアルでは、このプロセスについて説明します。
データの一覧またはテーブルを表示しますが、単一の列またはプロパティを表示する必要もある ComboBox のような LookupBindingPropertiesAttribute をコントロールに実装します。詳細については、「チュートリアル: 検索データバインドをサポートする Windows フォームユーザーコントロールの作成」を参照してください。

このチュートリアルでは、テーブルからのデータ行を表示する複合コントロールを作成します。この例では、Northwind サンプルデータベースの Customers テーブルを使用します。複合ユーザーコントロールは、カスタムコントロールの DataGridView で Customers テーブルを表示します。

このチュートリアルでは、次の作業を行う方法について説明します。

新しい Windows アプリケーションを作成します。
新しいユーザーコントロールをプロジェクトに追加します。
ユーザーコントロールをビジュアルに設計します。
ComplexBindingProperty 属性を実装します。
データソース構成ウィザードを使用して、データセットを作成します。
ウィンドウの Customers テーブルが新しい複合コントロールを使用するように設定します。
[データソース] ウィンドウから Form1 に新しいコントロールをドラッグして追加します。

必須コンポーネント

このチュートリアルを完了するための要件は次のとおりです。

Northwind サンプルデータベースにアクセスします。詳細については、「方法 : サンプルデータベースをインストールする」を参照してください。

Windows アプリケーションの作成

最初に Windows アプリケーションを作成します。

新しい Windows プロジェクトを作成するには

Visual Studio の [ファイル] メニューの [新しいプロジェクト] をクリックします。
プロジェクトに ComplexControlWalkthrough という名前を付けます。
[Windows アプリケーション] をクリックし、[OK] をクリックします。詳細については、「クライアントアプリケーション」を参照してください。

ComplexControlWalkthrough プロジェクトが作成されてソリューションエクスプローラーに追加されます。

プロジェクトへのユーザーコントロールの追加

このチュートリアルではユーザーコントロールからデータバインディング可能な複合コントロールを作成するので、ユーザーコントロールの項目をプロジェクトに追加する必要があります。

プロジェクトにユーザーコントロールを追加するには

[プロジェクト] メニューの [ユーザーコントロールの追加] を選択します。
[ファイル名] 領域に「ComplexDataGridView」と入力し、[追加] をクリックします。

ComplexDataGridView コントロールが ソリューションエクスプローラーに追加され、デザイナーが開きます。

ComplexDataGridView コントロールの設計

この手順では、ユーザーコントロールに DataGridView を追加します。

ComplexDataGridView コントロールを設計するには

ツールボックスからユーザーコントロールのデザインサーフェイスに DataGridView をドラッグします。

必要なデータバインディング属性の追加

データバインディングをサポートする複合コントロールには、ComplexBindingPropertiesAttribute を実装できます。

ComplexBindingProperties 属性を実装するには

ComplexDataGridView コントロールをコードビューに切り替えます。 [表示] メニューの [コード] を選択します。

ComplexDataGridView のコードを次のコードで置き換えます。

using System.Windows.Forms;

namespace CS
{
    [System.ComponentModel.ComplexBindingProperties("DataSource", "DataMember")]
    public partial class ComplexDataGridView : UserControl
    {
        public object DataSource
        {
            get{ return dataGridView1.DataSource; }
            set{ dataGridView1.DataSource = value; }
        }

        public string DataMember
        {
            get{ return dataGridView1.DataMember; }
            set{ dataGridView1.DataMember = value; }
        }

        public ComplexDataGridView()
        {
            InitializeComponent();
        }
    }
}

<System.ComponentModel.ComplexBindingProperties("DataSource", "DataMember")>
Public Class ComplexDataGridView

    Public Property DataSource() As Object
        Get
            Return DataGridView1.DataSource
        End Get
        Set(ByVal value As Object)
            DataGridView1.DataSource = value
        End Set
    End Property

    Public Property DataMember() As String
        Get
            Return DataGridView1.DataMember
        End Get
        Set(ByVal value As String)
            DataGridView1.DataMember = value
        End Set
    End Property
End Class

[ビルド] メニューの [ソリューションのビルド] をクリックします。

データベースからのデータソースの作成

この手順では、データソース構成ウィザードを使用して、Northwind サンプルデータベースの Customers テーブルに基づいてデータソースを作成します。接続を作成するには、Northwind サンプルデータベースへのアクセス権を持っている必要があります。 Northwind サンプルデータベースのセットアップの詳細については、「方法 : サンプルデータベースをインストールする」を参照してください。

データソースを作成するには

[データ] メニューの [データソースの表示] をクリックします。
[データソース] ウィンドウで、[新しいデータソースの追加] をクリックしてデータソース構成ウィザードを起動します。
[データソースの種類を選択] ページで、[データベース] をクリックし、[次へ] をクリックします。
[データ接続の選択] ページで、次のいずれかの操作を行います。
- Northwind サンプルデータベースへのデータ接続がドロップダウンリストに表示されている場合は選択します。
  
  または
- [新しい接続] を選択して [接続の追加] または [接続の変更] ダイアログボックスを表示します。
データベースにパスワードが必要な場合は、該当するオプションを選択して重要情報を含め、[次へ] をクリックします。
[アプリケーション構成ファイルに接続文字列を保存] ページで、[次へ] をクリックします。
[データベースオブジェクトの選択] ページの [テーブル] ノードを展開します。
Customers テーブルを選択し、[完了] をクリックします。

プロジェクトに NorthwindDataSet が追加され、[データソース] ウィンドウに Customers テーブルが表示されます。

ComplexDataGridView コントロールを使用するように Customers テーブルを設定する

[データソース] ウィンドウでは、フォームにコントロールをドラッグする前に作成するコントロールを設定できます。

Customers テーブルを ComplexDataGridView コントロールにバインドするように設定するには

デザイナーで Form1 を開きます。
[データソース] ウィンドウの [Customers] ノードを展開します。
[Customers] ノードのドロップダウン矢印をクリックし、[カスタマイズ] をクリックします。
[データ UI カスタマイズオプション] ダイアログボックスの [関連付けられたコントロール] の一覧の [ComplexDataGridView] を選択します。
Customers テーブルのドロップダウン矢印をクリックし、コントロールリストから ComplexDataGridView を選択します。

フォームへのコントロールの追加

[データソース] ウィンドウからフォームに項目をドラッグして、データバインドコントロールを作成します。

フォームにデータバインドコントロールを作成するには

[データソース] ウィンドウからフォームにメインの [Customers] ノードをドラッグし、ComplexDataGridView コントロールを使用してテーブルのデータが表示されていることを確認します。

アプリケーションの実行

アプリケーションを実行するには

F5 キーを押してアプリケーションを実行します。

次の手順

アプリケーションの要件に応じて、データバインディングをサポートするコントロールの作成後に、追加の操作を実行できます。次の手順として、一般的には、次のようなことを実行します。

他のアプリケーションで再利用できるように、コントロールライブラリにカスタムコントロールを配置します。
検索のシナリオをサポートするコントロールを作成します。詳細については、「チュートリアル: 検索データバインドをサポートする Windows フォームユーザーコントロールの作成」を参照してください。

参照

[データソース] ウィンドウからドラッグしたときに作成されるコントロールを設定する
 Windows フォームコントロール
 Visual Studio でのデータへの Windows フォームコントロールのバインド
 Visual Studio でのデータへの接続
 アプリケーションでデータを受け取る準備
 アプリケーションへのデータのフェッチ
 Visual Studio でのデータへのコントロールのバインド
 アプリケーションでのデータ編集
 データの検証
 データの保存

チュートリアル: 複合データ バインドをサポートする Windows フォーム ユーザー コントロールの作成