CompositeDataBoundControl クラスとは何？わかりやすく解説 Weblio辞書

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

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

CompositeDataBoundControl クラス

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

他の複数のサーバーコントロールで構成される表形式のデータバインドコントロールの基本クラスを表します。

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

Visual Basic (宣言)

Public MustInherit Class
 CompositeDataBoundControl
    Inherits DataBoundControl
    Implements INamingContainer

Visual Basic (使用法)

Dim instance As CompositeDataBoundControl

public abstract class CompositeDataBoundControl
 : DataBoundControl, INamingContainer

C++

public ref class CompositeDataBoundControl
 abstract : public DataBoundControl, INamingContainer

public abstract class CompositeDataBoundControl
 extends DataBoundControl implements INamingContainer

JScript

public abstract class CompositeDataBoundControl
 extends DataBoundControl implements INamingContainer

解説

CompositeDataBoundControl クラスは、データソースからデータにバインドされる複合サーバーコントロールの基本クラスとして機能します。複合サーバーコントロールは、他のサーバーコントロールの組み合わせから作成されるコントロールです。ページ開発者は、CompositeDataBoundControl クラスを直接使用するのではなく、このクラスから派生するコントロールを使用します。複合データバインドコントロールの例には、DetailsView、FormView、および GridView の各コントロールがあります。

CompositeDataBoundControl コントロールから継承するクラスは、CreateChildControls(IEnumerable,Boolean) メソッドをオーバーライドしてコントロール階層を作成する必要があります。複合データバインドコントロールの子コントロールにアクセスするには、Controls コレクションを使用します。

継承時の注意 CompositeDataBoundControl クラスから継承する場合は、CreateChildControls(IEnumerable,Boolean) のメンバをオーバーライドする必要があります。

使用例

データソースの値をテーブルに表示するカスタム複合データバインドコントロールを作成する方法を次のコード例に示します。

Visual Basic

Imports System
Imports System.Collections
Imports System.Data.Common
Imports System.Web.UI
Imports System.Web.UI.WebControls

Namespace Samples.AspNet.VB

    Public Class SimpleSpreadsheetControl
        Inherits CompositeDataBoundControl

        Protected table As New
 Table()

        Public Overridable ReadOnly
 Property Rows() As TableRowCollection
            Get
                Return table.Rows
            End Get
        End Property


        Protected Overrides Function
 CreateChildControls(ByVal dataSource As IEnumerable,
 ByVal dataBinding As Boolean) As Integer

            Dim count As Integer
 = 0
            ' If dataSource is not Nothing, iterate through it and
            ' extract each element from it as a row, then
            ' create a SimpleSpreadsheetRow and add it to the
            ' rows collection.
            If Not (dataSource Is
 Nothing) Then

                Dim row As SimpleSpreadsheetRow
                Dim e As IEnumerator = dataSource.GetEnumerator()

                While e.MoveNext()
                    Dim datarow As Object
 = e.Current
                    row = New SimpleSpreadsheetRow(count, datarow)
                    Me.Rows.Add(row)
                    count += 1
                End While

                Controls.Add(table)
            End If
            Return count
        End Function 'CreateChildControls
    End Class 'SimpleSpreadsheetControl


    Public Class SimpleSpreadsheetRow
        Inherits TableRow
        Implements IDataItemContainer

        Private dataObj As Object
        Private _itemIndex As Integer

        Public Sub New(ByVal
 itemIndex As Integer, ByVal
 o As Object)
            dataObj = o
            _itemIndex = itemIndex
        End Sub 'New

        Public Overridable ReadOnly
 Property Data() As Object
            Get
                Return dataObj
            End Get
        End Property

        ReadOnly Property DataItem() As
 Object Implements IDataItemContainer.DataItem
            Get
                Return Data
            End Get
        End Property

        ReadOnly Property DataItemIndex() As
 Integer Implements IDataItemContainer.DataItemIndex
            Get
                Return _itemIndex
            End Get
        End Property

        ReadOnly Property DisplayIndex() As
 Integer Implements IDataItemContainer.DisplayIndex
            Get
                Return _itemIndex
            End Get
        End Property
        Protected Overrides Sub
 RenderContents(ByVal writer As HtmlTextWriter)

            If Not (Data Is
 Nothing) Then
                If TypeOf Data Is
 System.Data.Common.DbDataRecord Then
                    Dim temp As DbDataRecord
 = CType(Data, DbDataRecord)
                    Dim i As Integer

                    While i < temp.FieldCount
                        writer.Write("<TD>")
                        writer.Write(temp.GetValue(i).ToString())
                        writer.Write("</TD>")
                        i += 1
                    End While
                Else
                    writer.Write(("<TD>" + Data.ToString()
 + "</TD>"))
                End If

            Else
                writer.Write("<TD>This is a test</TD>")
            End If
        End Sub 'RenderContents
    End Class 'SimpleSpreadsheetRow
End Namespace

using System;
using System.Collections;
using System.Data.Common;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace Samples.AspNet.CS
{
    public class SimpleSpreadsheetControl :
 CompositeDataBoundControl
    {
        protected Table table = new Table();

        public virtual TableRowCollection Rows
        {
            get
            {
                return table.Rows;
            }
        }

        protected override int CreateChildControls(IEnumerable
 dataSource, bool dataBinding)
        {

            int count = 0;
            // If dataSource is not null, iterate through it and
            // extract each element from it as a row, then
            // create a SimpleSpreadsheetRow and add it to the
            // rows collection.
            if (dataSource != null)
            {

                SimpleSpreadsheetRow row;
                IEnumerator e = dataSource.GetEnumerator();

                while (e.MoveNext())
                {
                    object datarow = e.Current;
                    row = new SimpleSpreadsheetRow(count, datarow);
                    this.Rows.Add(row);
                    ++count;
                }

                Controls.Add(table);
            }
            return count;
        }
    }

    //
    //
    public class SimpleSpreadsheetRow : TableRow,
 IDataItemContainer
    {
        private object data;
        private int _itemIndex;

        public SimpleSpreadsheetRow(int itemIndex,
 object o)
        {
            data = o;
            _itemIndex = itemIndex;
        }

        public virtual object Data
        {
            get
            {
                return data;
            }
        }
        object IDataItemContainer.DataItem
        {
            get
            {
                return Data;
            }
        }
        int IDataItemContainer.DataItemIndex
        {
            get
            {
                return _itemIndex;
            }
        }
        int IDataItemContainer.DisplayIndex
        {
            get
            {
                return _itemIndex;
            }
        }
        protected override void RenderContents(HtmlTextWriter
 writer)
        {

            if (Data != null)
            {
                if (Data is System.Data.Common.DbDataRecord)
                {
                    DbDataRecord temp = (DbDataRecord)Data;
                    for (int i = 0; i <
 temp.FieldCount; ++i)
                    {
                        writer.Write("<TD>");
                        writer.Write(temp.GetValue(i).ToString());
                        writer.Write("</TD>");
                    }
                }
                else
                    writer.Write("<TD>" + Data.ToString() + "</TD>");
            }

            else
                writer.Write("<TD>This is a test</TD>");
        }
    }
}

.NET Framework のセキュリティ

AspNetHostingPermission (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
AspNetHostingPermission (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.Web.UI.Control
     System.Web.UI.WebControls.WebControl
       System.Web.UI.WebControls.BaseDataBoundControl
         System.Web.UI.WebControls.DataBoundControl
          System.Web.UI.WebControls.CompositeDataBoundControl
             System.Web.UI.WebControls.DetailsView
             System.Web.UI.WebControls.FormView
             System.Web.UI.WebControls.GridView

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
CompositeDataBoundControl メンバ
System.Web.UI.WebControls 名前空間
BaseDataBoundControl クラス
DataBoundControl
HierarchicalDataBoundControl
DetailsView
FormView
GridView
Controls

>> 「CompositeDataBoundControl クラス」を含む用語の索引
CompositeDataBoundControl クラスのページへのリンク

CompositeDataBoundControl クラスとは？わかりやすく解説