ControlBuilder クラス

リファレンス

定義

名前空間:: System.Web.UI

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

コントロールとその子コントロールを作成するときにページパーサーをサポートします。

public ref class ControlBuilder

public class ControlBuilder

type ControlBuilder = class

Public Class ControlBuilder

継承: Object
ControlBuilder

派生: System.Web.UI.CodeStatementBuilder

System.Web.UI.DataSourceControlBuilder

System.Web.UI.HtmlControls.HtmlEmptyTagControlBuilder

System.Web.UI.HtmlControls.HtmlHeadBuilder

System.Web.UI.HtmlControls.HtmlSelectBuilder

その他…

例

次のコード例では、テーブルの Table 作成時に属性とコンテンツを定義するコントロールを作成します。実行可能ファイルのビルドに使用するコマンドラインを次に示します。

vbc /r:System.dll /r:System.Web.dll /r:System.Drawing.dll /t:library /out:myWebAppPath/Bin/vb_mycontrolbuilder.dll myControlBuilder.vb

csc /t:library /out:myWebAppPath/Bin/cs_mycontrolbuilder.dll myControlBuilder.cs

using System;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Collections;
using System.Drawing;
using System.Security.Permissions;

namespace CustomControls
{
    [AspNetHostingPermission(SecurityAction.Demand,
        Level = AspNetHostingPermissionLevel.Minimal)]
    public class MyTableCell : TableCell, INamingContainer { };

    [AspNetHostingPermission(SecurityAction.Demand,
        Level = AspNetHostingPermissionLevel.Minimal)]
    public class MyCell
    /*
     * Class name: MyCell.
     * Declares the class for the child controls to include in the control collection.
     */
    {
        string _id;
        string _value;
        Color _backColor;

        public string CellID
        {
            get
            { return _id; }
            set
            { _id = value; }
        }

        public string Text
        {
            get
            { return _value; }
            set
            { _value = value; }
        }

        public Color BackColor
        {
            get
            { return _backColor; }
            set
            { _backColor = value; }
        }
    };

    [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
    public class MyControlBuilder : ControlBuilder
    {

        public override Type GetChildControlType(string tagName, IDictionary attribs)
        {
            // Allows TableRow without "runat=server" attribute to be added to the collection.
            if (String.Compare(tagName, "mycell", true) == 0)
                return typeof(MyCell);
            return null;
        }

        public override void AppendLiteralString(string s)
        {
            // Ignores literals between rows.
        }
    }
    [AspNetHostingPermission(SecurityAction.Demand,
        Level = AspNetHostingPermissionLevel.Minimal)]
    [ControlBuilderAttribute(typeof(MyControlBuilder))]
    public class MyCS_CustomControl : Control, INamingContainer
    /*
     * Class name: MyCS_CustomControl.
     * Processes the element declarations within a control declaration. 
     * This builds the actual control.
     */
    {
        // Declares the custom control that must be built programmatically.
        Table _table;

        private String _title;
        private int _rows;
        private int _columns;

        Hashtable _cellObjects = new Hashtable();

        // Rows property to be used as the attribute name in the Web page.  
        public int Rows
        {
            get
            { return _rows; }
            set
            { _rows = value; }
        }

        // Columns property to be used as the attribute name in the Web page.
        public int Columns
        {
            get
            { return _columns; }
            set
            { _columns = value; }
        }

        // Title property to be used as the attribute name in the Web page.
        public string Title
        {
            get
            { return _title; }
            set
            { _title = value; }
        }

        protected void createNewRow(int rowNumber)
        {

            // Creates a row and adds it to the table.
            TableRow row;

            row = new TableRow();
            _table.Rows.Add(row);

            // Creates a cell that contains text.

            for (int y = 0; y < Columns; y++)
                appendCell(row, rowNumber, y);
        }

        protected void appendCell(TableRow row, int rowNumber, int cellNumber)
        {
            TableCell cell;
            TextBox textbox;

            cell = new TableCell();
            textbox = new TextBox();
            cell.Controls.Add(textbox);
            textbox.ID = "r" + rowNumber.ToString() + "c" + cellNumber.ToString();

            // Checks for the MyCell child object.
            if (_cellObjects[textbox.ID] != null)
            {
                MyCell cellLookup;
                cellLookup = (MyCell)_cellObjects[textbox.ID];

                textbox.Text = cellLookup.Text;
                textbox.BackColor = cellLookup.BackColor;
            }
            else
                textbox.Text = "Row: " + rowNumber.ToString() + " Cell: " +
                cellNumber.ToString();

            row.Cells.Add(cell);
        }

        // Called at runtime when a child object is added to the collection.  
        protected override void AddParsedSubObject(object obj)
        {
            MyCell cell = obj as MyCell;
            if (cell != null)
            {
                _cellObjects.Add(cell.CellID, cell);
            }
        }

        protected override void OnPreRender(EventArgs e)
        /*
         * Function name: OnPreRender.
         * Carries out changes affecting the control state and renders the resulting UI.
        */
        {

            // Increases the number of rows if needed.
            while (_table.Rows.Count < Rows)
            {
                createNewRow(_table.Rows.Count);
            }

            // Checks that each row has the correct number of columns.
            for (int i = 0; i < _table.Rows.Count; i++)
            {
                while (_table.Rows[i].Cells.Count < Columns)
                {
                    appendCell(_table.Rows[i], i, _table.Rows[i].Cells.Count);
                }

                while (_table.Rows[i].Cells.Count > Columns)
                {
                    _table.Rows[i].Cells.RemoveAt(_table.Rows[i].Cells.Count - 1);
                }
            }
        }

        protected override void CreateChildControls()
        /*
         * Function name: CreateChildControls.
         * Adds the Table and the text control to the control collection.
         */
        {
            LiteralControl text;

            // Initializes the text control using the Title property.
            text = new LiteralControl("<h5>" + Title + "</h5>");
            Controls.Add(text);

            _table = new Table();
            _table.BorderWidth = 2;
            Controls.Add(_table);
        }
    }
}

Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Collections
Imports System.Drawing
Imports System.Security.Permissions


Namespace CustomControls

    <AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
    Public Class MyTableCell
        Inherits TableCell
        Implements INamingContainer
    End Class


    <AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
    Public Class MyCell
        Inherits Control
        Implements INamingContainer
        ' Class Name: MyCell.
        ' Declares the class for the child controls to be included in the control collection.

        Private _id As String
        Private _value As String
        Private _backColor As Color

        Public Property CellID() As String
            Get
                Return _id
            End Get
            Set(ByVal value As String)
                _id = value
            End Set
        End Property

        Public Property Text() As String
            Get
                Return _value
            End Get
            Set(ByVal value As String)
                _value = value
            End Set
        End Property


        Public Property BackColor() As Color
            Get
                Return _backColor
            End Get
            Set(ByVal value As Color)
                _backColor = value
            End Set
        End Property
    End Class

    <AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
    Public Class MyControlBuilderVB
        Inherits ControlBuilder

        Public Overrides Function GetChildControlType(ByVal tagName As String, ByVal attribs As IDictionary) As Type

            ' Allows TableRow without "runat=server" attribute to be added to the collection.
            If (String.Compare(tagName, "mycell", True) = 0) Then
                Return GetType(MyCell)
            End If
            Return Nothing
        End Function

        ' Ignores literals between rows.
        Public Overrides Sub AppendLiteralString(ByVal s As String)
            ' Ignores literals between rows.
        End Sub

    End Class

    <AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal), ControlBuilderAttribute(GetType(MyControlBuilderVB))> _
        Public Class MyVB_CustomControl
        Inherits Control
        Implements INamingContainer

        ' Class name: MyVB_CustomControl.
        ' Processes the element declarations within a control 
        ' declaration. This builds the actual control.

        ' Custom control to build programmatically.
        Private _table As Table

        Private _cellObjects As New Hashtable()

        ' Variables that must contain the control attributes as defined in the Web page.
        Private _rows As Integer
        Private _columns As Integer
        Private _title As String

        ' Rows property to be used as the attribute name in the Web page.     
        Public Property Rows() As Integer
            Get
                Return _rows
            End Get
            Set(ByVal value As Integer)
                _rows = value
            End Set
        End Property

        ' Columns property to be used as the attribute name in the Web page.

        Public Property Columns() As Integer
            Get
                Return _columns
            End Get
            Set(ByVal value As Integer)
                _columns = value
            End Set
        End Property

        ' Title property to be used as the attribute name in the Web page   
        Public Property Title() As String
            Get
                Return _title
            End Get
            Set(ByVal value As String)
                _title = value
            End Set
        End Property


        Protected Sub createNewRow(ByVal rowNumber As Integer)

            ' Creates a row and adds it to the table.
            Dim row As TableRow

            row = New TableRow()
            _table.Rows.Add(row)

            ' Creates a cell that contains text.
            Dim y As Integer
            For y = 0 To Columns - 1
                appendCell(row, rowNumber, y)
            Next y
        End Sub


        Protected Sub appendCell(ByVal row As TableRow, ByVal rowNumber As Integer, ByVal cellNumber As Integer)
            Dim cell As TableCell
            Dim textbox As TextBox

            cell = New TableCell()

            textbox = New TextBox()

            cell.Controls.Add(textbox)

            textbox.ID = "r" + rowNumber.ToString() + "c" + cellNumber.ToString()

            ' Checks for the MyCell child object.
            If Not (_cellObjects(textbox.ID) Is Nothing) Then
                Dim cellLookup As MyCell
                cellLookup = CType(_cellObjects(textbox.ID), MyCell)

                textbox.Text = cellLookup.Text
                textbox.BackColor = cellLookup.BackColor

            Else
                textbox.Text = "Row: " + rowNumber.ToString() + " Cell: " + cellNumber.ToString()
            End If

            row.Cells.Add(cell)
        End Sub

        ' Called at runtime when a child object is added to the collection.
        Protected Overrides Sub AddParsedSubObject(ByVal obj As Object)

            Dim cell As MyCell = CType(obj, MyCell)
            If Not (cell Is Nothing) Then
                _cellObjects.Add(cell.CellID, cell)
            End If
        End Sub


        Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
            ' Sub name: OnPreRender.
            ' Carries out changes affecting the control state and renders the resulting UI.

            ' Increases the number of rows if needed.
            While _table.Rows.Count < Rows
                createNewRow(_table.Rows.Count)
            End While

            ' Checks that each row has the correct number of columns.
            Dim i As Integer
            For i = 0 To _table.Rows.Count - 1
                While _table.Rows(i).Cells.Count < Columns
                    appendCell(_table.Rows(i), i, _table.Rows(i).Cells.Count)
                End While

                While _table.Rows(i).Cells.Count > Columns
                    _table.Rows(i).Cells.RemoveAt((_table.Rows(i).Cells.Count - 1))
                End While
            Next i
        End Sub


        <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
        Protected Overrides Sub CreateChildControls()
            ' Sub name: CreateChildControls.
            ' Adds the Table and the text controls to the control collection. 


            Dim [text] As LiteralControl

            ' Initializes the text control using the Title property.
            [text] = New LiteralControl("<h5>" + Title + "</h5>")
            Controls.Add([text])


            _table = New Table()

            Controls.Add(_table)
        End Sub
    End Class

End Namespace

次のコード例では、前のカスタムコントロールを使用します。特に、実行時に属性とコンテンツが定義されているテーブルを作成します。 @ Register ディレクティブに示されている値は、前のコマンドラインを反映していることに注意してください。

<%@ Page Language="C#" %>
<%@ Register TagPrefix="AspNetSamples" Assembly="cs_mycontrolbuilder" Namespace="CustomControls" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ControlBuilder Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
       <AspNetSamples:MyCS_CustomControl id="Custom1" 
                                         title="Auto-Generated Table"
                                         columns="3"
                                         rows="3"  
                                         runat="server">
         <mycell cellid="r0c0" BackColor="red" text="red cell"></mycell>
         <mycell cellid="r2c2" BackColor="green" text="green cell"></mycell>
       </AspNetSamples:MyCS_CustomControl>
    </div>
    </form>
</body>
</html>

<%@ Page Language="VB" %>
<%@ Register TagPrefix="AspNetSamples" Assembly="vb_mycontrolbuilder" Namespace="CustomControls" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ControlBuilder Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
       <AspNetSamples:MyVB_CustomControl id="Custom1" 
                                         title="Auto-Generated Table"
                                         columns="3"
                                         rows="3"  
                                         runat="server">
         <mycell cellid="r0c0" BackColor="red" text="red cell"></mycell>
         <mycell cellid="r2c2" BackColor="green" text="green cell"></mycell>
       </AspNetSamples:MyVB_CustomControl>
    </div>
    </form>
</body>
</html>

注釈

既定では、ページ上のすべてのコントロールは既定 ControlBuilder のクラスに関連付けられます。解析中、ASP.NET ページフレームワークは、ページのコントロールの ControlBuilder ツリーに対応するオブジェクトのツリーを構築します。 ControlBuilderその後、ツリーを使用して、コントロールツリーを作成するページコードを生成します。は、子コントロールに加えて、 ControlBuilder コントロールタグ内のコンテンツの解析方法の動作を定義します。独自のカスタムコントロールビルダークラスを定義することで、この既定の動作をオーバーライドできます。これは、次のように属性を ControlBuilderAttribute コントロールビルダークラスに適用することによって行われます。

[ControlBuilderAttribute(typeof(ControlBuilderType))]

コンストラクター

ControlBuilder()

ControlBuilder クラスの新しいインスタンスを初期化します。

フィールド

DesignerFilter

リテラル文字列を "__designer" 表します。

プロパティ

BindingContainerBuilder	このビルダーが作成するコントロールのバインディングコンテナーに対応するコントロールビルダーを取得します。
BindingContainerType	このビルダーが作成するコントロールのバインディングコンテナーの型を取得します。
ComplexPropertyEntries	複合プロパティエントリのコレクションを取得します。
ControlType	作成するコントロールの Type を取得します。
CurrentFilterResolutionService	デザイナー上でコントロールを解析したり永続化したりする際に、デバイスフィルター関連サービスを管理するために使用される IFilterResolutionService オブジェクトを取得します。
DeclareType	コントロールを宣言するためにコード生成で使用される型を取得します。
FChildrenAsProperties	コントロールに ParseChildrenAttribute が `true` に設定された ChildrenAsProperties があるかどうかを決定する値を取得します。
FIsNonParserAccessor	コントロールが IParserAccessor インターフェイスを実装するかどうかを決定する値を取得します。
HasAspCode	コントロールにコードブロックが格納されているかどうかを示す値を取得します。
ID	作成するコントロールの識別子プロパティを取得または設定します。
InDesigner	ControlBuilder がデザイナーで実行されているかどうかを示す値を返します。
InPageTheme	この ControlBuilder オブジェクトを使用してページテーマを生成するかどうかを示すブール値を取得します。
ItemType	バインディングコンテナーに設定される型を取得します。
Localize	この ControlBuilder オブジェクトによって作成されるコントロールがローカライズされるかどうかを示すブール値を取得します。
NamingContainerType	このビルダーが作成するコントロールの名前付けコンテナーの型を取得します。
PageVirtualPath	この ControlBuilder インスタンスによって作成されるページの仮想パスを取得します。
Parser	コントロールを解析する TemplateParser を取得します。
ServiceProvider	この ControlBuilder オブジェクトのサービスオブジェクトを取得します。
SubBuilders	この ControlBuilder オブジェクトの子 ControlBuilder オブジェクトのリストを取得します。
TagName	作成するコントロールのタグ名を取得します。
TemplatePropertyEntries	テンプレートプロパティエントリのコレクションを取得します。
ThemeResolutionService	デザイン時にコントロールのテーマとスキンを管理するために使用される IThemeResolutionService オブジェクトを取得します。

メソッド

AllowWhitespaceLiterals()	コントロールの開始タグと終了タグの間のコンテンツで空白文字リテラルが許可されるかどうかを決定します。このメソッドは、ASP.NET ページフレームワークによって呼び出されます。
AppendLiteralString(String)	指定されたリテラルコンテンツをコントロールに追加します。このメソッドは、ASP.NET ページフレームワークによって呼び出されます。
AppendSubBuilder(ControlBuilder)	コンテナーコントロールに属しているすべての子コントロールの ControlBuilder オブジェクトにビルダーを追加します。
BuildObject()	この ControlBuilder オブジェクトによって参照されるコントロールのデザイン時のインスタンスを作成します。
CloseControl()	コントロールの開始タグと終了タグの解析が完了したことをビルダーに通知するためにパーサーによって呼び出されます。
CreateBuilderFromType(TemplateParser, ControlBuilder, Type, String, String, IDictionary, Int32, String)	指定されたタグ名、オブジェクト型、およびビルダーを定義する他のさまざまなパラメーターを使用して、ControlBuilder オブジェクトを作成します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetChildControlType(String, IDictionary)	子タグに対応するコントロールの種類の Type を取得します。このメソッドは、ASP.NET ページフレームワークによって呼び出されます。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetObjectPersistData()	この ObjectPersistData オブジェクトの ControlBuilder オブジェクトを作成します。
GetResourceKey()	この ControlBuilder オブジェクトのリソースキーを取得します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
HasBody()	コントロールに開始タグと終了タグの両方のタグを含めるかどうかを決定します。このメソッドは、ASP.NET ページフレームワークによって呼び出されます。
HtmlDecodeLiterals()	HTML コントロールのリテラル文字列を HTML デコードするかどうかを決定します。このメソッドは、ASP.NET ページフレームワークによって呼び出されます。
Init(TemplateParser, ControlBuilder, Type, String, String, IDictionary)	インスタンス化後、ControlBuilder を初期化します。このメソッドは、ASP.NET ページフレームワークによって呼び出されます。
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
NeedsTagInnerText()	コントロールビルダーがその内部テキストを取得するかどうかを決定します。内部テキストを取得する必要がある場合は、SetTagInnerText(String) メソッドを呼び出す必要があります。このメソッドは、ASP.NET ページフレームワークによって呼び出されます。
OnAppendToParentBuilder(ControlBuilder)	親コントロールビルダーに追加されることを ControlBuilder に通知します。
ProcessGeneratedCode(CodeCompileUnit, CodeTypeDeclaration, CodeTypeDeclaration, CodeMemberMethod, CodeMemberMethod)	カスタムコントロールビルダーが、生成された CodeDom (Code Document Object Model) にアクセスし、コントロールの解析とビルドのプロセス中にコードを挿入および更新できるようにします。
SetResourceKey(String)	この ControlBuilder オブジェクトのリソースキーを設定します。
SetServiceProvider(IServiceProvider)	この ControlBuilder オブジェクトのサービスオブジェクトを設定します。
SetTagInnerText(String)	ControlBuilder にコントロールタグの内部テキストを提供します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

適用対象

次の方法で共有