DataSourceControl.GetViewNames メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

DataSourceControl.GetViewNames メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

DataSourceControl コントロールに関連付けられた DataSourceView オブジェクトのリストを表す名前のコレクションを取得します。

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Protected Overridable Function
 GetViewNames As ICollection

Visual Basic (使用法)

Dim returnValue As ICollection

returnValue = Me.GetViewNames

protected virtual ICollection GetViewNames ()

C++

protected:
virtual ICollection^ GetViewNames ()

protected ICollection GetViewNames ()

JScript

protected function GetViewNames () : ICollection

戻り値
DataSourceControl に関連付けられた DataSourceView オブジェクトの名前が格納されている ICollection。

解説

名前の ICollection コレクションは、GetView メソッドに渡せる許容値を表すセットです。

DataSourceControl クラスの IListSource の実装に使用される ListSourceHelper クラスは、System.ComponentModel.IListSource.ContainsListCollection 呼び出しおよび System.ComponentModel.IListSource.GetList 呼び出しの両方で GetViewNames メソッドを確認し、データソースコントロールが 1 つ以上のデータソースビューに関連付けられているかどうかを判断します。GetViewNames が null 参照 (Visual Basic では Nothing) を返す場合、メソッドの既定の実装を示します。この場合、System.ComponentModel.IListSource.ContainsListCollection が false を返し、System.ComponentModel.IListSource.GetList が null 参照 (Visual Basic では Nothing) を返します。

メモ
DataSourceControl クラスの既定の実装では、null 参照 (Visual Basic では Nothing) を返します。DataSourceControl クラスを拡張する場合は、GetViewNames メソッドをオーバーライドし、ビュー名のコレクションを返します。

使用例

DataSourceControl クラスを拡張するクラスで、null 参照 (Visual Basic では Nothing) を返す既定の実装をオーバーライドしてビュー名のコレクションを提供する方法を次のコード例に示します。CsvDataSource クラスは 1 つのビューしかサポートしないため、既定のビュー名を持つ 1 つの要素のコレクションが返されます。このコード例は、DataSourceControl クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

   ' The ListSourceHelper class calls GetList, which
   ' calls the DataSourceControl.GetViewNames method.
   ' Override the original implementation to return
   ' a collection of one element, the default view name.
   Protected Overrides Function
 GetViewNames() As ICollection
      Dim al As New ArrayList(1)
      al.Add(CsvDataSourceView.DefaultViewName)
      Return CType(al, ICollection)
   End Function 'GetViewNames

End Class 'CsvDataSource

    // The ListSourceHelper class calls GetList, which
    // calls the DataSourceControl.GetViewNames method.
    // Override the original implementation to return
    // a collection of one element, the default view name.
    protected override ICollection GetViewNames() {
        ArrayList al = new ArrayList(1);
        al.Add(CsvDataSourceView.DefaultViewName);
        return al as ICollection;
    }
}