CompositeDataBoundControl.CreateChildControls メソッド

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls
アセンブリ:
System.Web.dll

複合データ バインド コントロールの表示に使用されるコントロール階層を作成します。

オーバーロード

CreateChildControls()

ビューステートに格納された値に基づいて、複合データ バインド コントロールの表示に使用されるコントロール階層を作成します。
CreateChildControls(IEnumerable, Boolean)

抽象クラスでオーバーライドされた場合、指定したデータ ソースの値に基づいて複合データ バインド コントロールを表示するために使用されるコントロール階層を作成します。

CreateChildControls()

ビューステートに格納された値に基づいて、複合データ バインド コントロールの表示に使用されるコントロール階層を作成します。

protected public:
 override void CreateChildControls();
protected internal override void CreateChildControls ();
override this.CreateChildControls : unit -> unit
Protected Friend Overrides Sub CreateChildControls ()

注釈

この CreateChildControls() メソッドは、複合データ バインド コントロールのコントロール階層を作成するためにクラスから CompositeDataBoundControl 派生するクラスによって使用されるヘルパー メソッドです。 このメソッドのオーバーロードは、データ ソースから直接ではなく、ビュー ステートの値に基づいてコントロール階層を作成します。

こちらもご覧ください

適用対象

CreateChildControls(IEnumerable, Boolean)

抽象クラスでオーバーライドされた場合、指定したデータ ソースの値に基づいて複合データ バインド コントロールを表示するために使用されるコントロール階層を作成します。

protected:
 abstract int CreateChildControls(System::Collections::IEnumerable ^ dataSource, bool dataBinding);
protected abstract int CreateChildControls (System.Collections.IEnumerable dataSource, bool dataBinding);
override this.CreateChildControls : System.Collections.IEnumerable * bool -> int
Protected MustOverride Function CreateChildControls (dataSource As IEnumerable, dataBinding As Boolean) As Integer

パラメーター

dataSource
IEnumerable

コントロールにバインドされる値を格納する IEnumerable。

dataBinding
Boolean

CreateChildControls(IEnumerable, Boolean) がデータ バインディング中に呼び出される場合は true。それ以外の場合は false。

戻り値

Int32

CreateChildControls(IEnumerable, Boolean) によって作成された項目数。

例

次のコード例では、カスタム コントロールのメソッドを CreateChildControls(IEnumerable, Boolean) オーバーライドしてコントロール階層を作成する方法を示します。

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>");
            }
        }
    }
}

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


    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

        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
    End Class
End Namespace

注釈

この CreateChildControls() メソッドは、複合データ バインド コントロールのコントロール階層を作成するためにクラスから CompositeDataBoundControl 派生するクラスによって使用されるヘルパー メソッドです。 クラスを拡張するときは、メソッドを CompositeDataBoundControl オーバーライドして独自の CreateChildControls() コントロール階層を作成する必要があります。 複合コントロールの作成の詳細については、「カスタム ASP.NET サーバー コントロールの開発」を参照してください。

こちらもご覧ください

適用対象