Web フォームデータ連結コントロールデザイナの実装

[アーティクル]
03/28/2008

データ連結コントロールデザイナの主なタスクは、コントロールがデザイナ内に存在するとき、そのコントロールが別の (サンプル) デザイン時データソースにアクセスできるようにすることです。.NET Framework には、データソースへのアクセスを有効にするコントラクトを指定するインターフェイス (IDataSourceProvider) が用意されています。データ連結サーバーコントロールのデザイナは、IDataSourceProvider インターフェイスおよび以下の手順で説明するその他の主要な機能を実装する必要があります。

データ連結コントロールデザイナを実装するには、次のようにします。

メモ以下の手順では、「Web フォームテンプレートデータ連結コントロールデザイナのサンプル」に示す特定の実装について説明します。この実装は、IEnumerable 参照を受け入れる object 型のデータソースを持つコントロールに適用できます。

ControlDesigner から直接または間接的に派生するクラスを定義し、次のコードで示すように IDataSourceProvider インターフェイスを実装します。

Public Class DataboundControlDesigner
   Inherits ControlDesigner
   Implements IDataSourceProvider
   ...
End Class
[C#]
public class DataboundControlDesigner : ControlDesigner, IDataSourceProvider {...}

デザイン時データソースを指定する string 型のプロパティ DataSource を公開します。このプロパティの実装方法の例については、「Web フォームテンプレートデータ連結コントロールデザイナのサンプル」を参照してください。デザイナの DataSource プロパティは、コントロールの DataBindings コレクションと共に機能します。
GetDesignTimeHtml メソッドをオーバーライドし、デザイナに関連付けられているコントロールのデータソースをデザイン時データソースに設定します。このメソッドをオーバーライドしてデータソースを置き換える方法の例については、「Web フォームテンプレートデータ連結コントロールデザイナのサンプル」を参照してください。

PreFilterProperties メソッドをオーバーライドして、コントロールの DataSource プロパティをデザイン時の DataSource プロパティで置換またはシャドウします。PreFilterProperties メソッドは IDesignerFilter インターフェイスに属します。このインターフェイスは、デザイナがデザイン時にプロパティおよびイベントを置換または作成できるようにします。IDesignerFilter は ControlDesigner によって実装されます。プロパティのフィルタ処理の詳細については、「メタデータフィルタ処理」を参照してください。PreFilterProperties メソッドをオーバーライドする方法を示すコードを次に示します。

Protected Overrides Sub PreFilterProperties(properties As IDictionary)
   MyBase.PreFilterProperties(properties)

   Dim prop As PropertyDescriptor

   prop = CType(properties("DataSource"), PropertyDescriptor)
   Debug.Assert(( Not (prop Is Nothing)))
   prop = TypeDescriptor.CreateProperty(Me.GetType(), prop, _
         New Attribute() {New TypeConverterAttribute(GetType(DataSourceConverter))})

   properties("DataSource") = prop
End Sub
[C#]
protected override void PreFilterProperties(IDictionary properties) {
            base.PreFilterProperties(properties);

            PropertyDescriptor prop;

            prop = (PropertyDescriptor)properties["DataSource"];
            Debug.Assert(prop != null);
            prop = TypeDescriptor.CreateProperty(this.GetType(), prop,
                                                 new Attribute[] {
                                                     new TypeConverterAttribute(typeof(DataSourceConverter))
                                                 });
            properties["DataSource"] = prop;
        }

IDataSourceProvider インターフェイスのメソッドを実装します。このインターフェイスは、GetResolvedSelectedDataSource と GetSelectedDataSource という 2 つのメソッドを持っています。「Web フォームテンプレートデータ連結コントロールデザイナのサンプル」で示すこれらのメソッドの実装のコード例を次に示します。

   Function GetResolvedSelectedDataSource() As IEnumerable Implements IDataSourceProvider.GetResolvedSelectedDataSource
      Return CType(CType(Me, IDataSourceProvider).GetSelectedDataSource(), IEnumerable)
   End Function

   Function GetSelectedDataSource() As Object Implements IDataSourceProvider.GetSelectedDataSource
      Dim selectedDataSource As Object = Nothing
      Dim dataSource As String = Nothing

      Dim binding As DataBinding = DataBindings("DataSource")
      If Not (binding Is Nothing) Then
         dataSource = binding.Expression
      End If

      If Not (dataSource Is Nothing) Then
         Dim componentSite As ISite = Component.Site
         If Not (componentSite Is Nothing) Then
            Dim container As IContainer = CType(componentSite.GetService(GetType(IContainer)), IContainer)

            If Not (container Is Nothing) Then
               Dim comp As IComponent = container.Components(dataSource)
               If TypeOf comp Is IEnumerable Then
                  selectedDataSource = comp
               End If
            End If
         End If
      End If

      Return selectedDataSource
   End Function
[C#]
IEnumerable IDataSourceProvider.GetResolvedSelectedDataSource() {
            return (IEnumerable)((IDataSourceProvider)this).GetSelectedDataSource();
        }

        object IDataSourceProvider.GetSelectedDataSource() {
            object selectedDataSource = null;
            string dataSource = null;

            DataBinding binding = DataBindings["DataSource"];
            if (binding != null) {
                dataSource = binding.Expression;
            }

            if (dataSource != null) {
                ISite componentSite = Component.Site;
                if (componentSite != null) {
                    IContainer container = (IContainer)componentSite.GetService(typeof(IContainer));

                    if (container != null) {
                        IComponent comp = container.Components[dataSource];
                        if (comp is IEnumerable) {
                            selectedDataSource = comp;
                        }
                    }
                }
            }

            return selectedDataSource;
        }

上記の手順を含む完全なサンプルについては、「Web フォームテンプレートデータ連結コントロールデザイナのサンプル」を参照してください。

参照

Web フォームテンプレートデータ連結コントロールデザイナのサンプル | Web フォームテンプレートエディタの実装 | カスタムデザイナ | Web フォームのデザイン時サポート

Share via

Web フォームデータ連結コントロールデザイナの実装

参照

その他のリソース

Share via

Web フォーム データ連結コントロール デザイナの実装

参照

その他のリソース

Web フォームデータ連結コントロールデザイナの実装