ControlBuilder Třída

Reference

Definice

Obor názvů:: System.Web.UI

Sestavení:: System.Web.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Podporuje analyzátor stránek při sestavování ovládacího prvku a podřízené ovládací prvky, které obsahuje.

public ref class ControlBuilder

public class ControlBuilder

type ControlBuilder = class

Public Class ControlBuilder

Dědičnost: Object
ControlBuilder

Odvozené: System.Web.UI.CodeStatementBuilder

System.Web.UI.DataSourceControlBuilder

System.Web.UI.HtmlControls.HtmlEmptyTagControlBuilder

System.Web.UI.HtmlControls.HtmlHeadBuilder

System.Web.UI.HtmlControls.HtmlSelectBuilder

Více…

Příklady

Následující příklad kódu vytvoří ovládací prvek Table , jehož atributy a obsah jsou definovány v době sestavení tabulky. Následuje příkazový řádek, který se má použít k sestavení spustitelného souboru.

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

Následující příklad kódu používá předchozí vlastní ovládací prvek. Konkrétně sestaví tabulku, jejíž atributy a obsah jsou definovány za běhu. Všimněte si, že hodnoty zobrazené v direktivě @ Register odpovídají předchozímu příkazovému řádku.

<%@ 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>

Poznámky

Ve výchozím nastavení je každý ovládací prvek na stránce přidružený k výchozí ControlBuilder třídě. Během analýzy rozhraní ASP.NET stránky vytvoří strom ControlBuilder objektů odpovídající stromu ovládacích prvků pro stránku. Strom se ControlBuilder pak použije k vygenerování kódu stránky k vytvoření řídicího stromu. Kromě podřízených ovládacích prvků ControlBuilder definuje chování způsobu parsování obsahu v rámci značek ovládacích prvků. Toto výchozí chování můžete přepsat definováním vlastní třídy tvůrce ovládacích prvků. To se provádí použitím atributu ControlBuilderAttribute na třídu tvůrce ovládacích prvků následujícím způsobem:

[ControlBuilderAttribute(typeof(ControlBuilderType))]

Konstruktory

ControlBuilder()

Inicializuje novou instanci ControlBuilder třídy .

Pole

DesignerFilter

Představuje řetězec literálu "__designer" .

Vlastnosti

BindingContainerBuilder	Získá tvůrce ovládacích prvků, který odpovídá kontejneru vazby pro ovládací prvek, který tento tvůrce vytvoří.
BindingContainerType	Získá typ kontejneru vazby pro ovládací prvek, který tento tvůrce vytvoří.
ComplexPropertyEntries	Získá kolekci položek komplexní vlastnosti.
ControlType	Type Získá pro ovládací prvek, který má být vytvořen.
CurrentFilterResolutionService	IFilterResolutionService Získá objekt, který se používá ke správě služeb souvisejících s filtrem zařízení při analýze a zachování ovládacích prvků v návrháři.
DeclareType	Získá typ, který bude použit generováním kódu k deklaraci ovládacího prvku.
FChildrenAsProperties	Získá hodnotu, která určuje, zda má ovládací prvek s ChildrenAsProperties nastavenou ParseChildrenAttribute na `true`.
FIsNonParserAccessor	Získá hodnotu, která určuje, zda ovládací prvek implementuje IParserAccessor rozhraní.
HasAspCode	Získá hodnotu označující, zda ovládací prvek obsahuje nějaké bloky kódu.
ID	Získá nebo nastaví vlastnost identifikátoru pro ovládací prvek, který má být sestaven.
InDesigner	Vrátí, zda je spuštěn v ControlBuilder návrháři.
InPageTheme	Získá logickou hodnotu označující, zda je tento ControlBuilder objekt použit ke generování motivů stránky.
ItemType	Získá typ nastavený na kontejner vazby.
Localize	Získá logická hodnota označující, zda je lokalizován ovládací prvek, který je vytvořen tímto ControlBuilder objektem.
NamingContainerType	Získá typ názvového kontejneru pro ovládací prvek, který tento tvůrce vytvoří.
PageVirtualPath	Získá virtuální cestu stránky, která má být vytvořena touto ControlBuilder instancí.
Parser	TemplateParser Získá zodpovědnost za parsování ovládacího prvku.
ServiceProvider	Získá objekt služby pro tento ControlBuilder objekt.
SubBuilders	Získá seznam podřízených ControlBuilder objektů pro tento ControlBuilder objekt.
TagName	Získá název značky pro ovládací prvek, který má být sestaven.
TemplatePropertyEntries	Získá kolekci položek vlastností šablony.
ThemeResolutionService	IThemeResolutionService Získá objekt, který se používá v době návrhu ke správě motivů a vzhledů ovládacích prvků.

Metody

AllowWhitespaceLiterals()	Určuje, zda jsou v obsahu mezi otevírací a zavírací značky ovládacího prvku povoleny prázdné mezery. Tato metoda je volána rozhraním stránky ASP.NET.
AppendLiteralString(String)	Přidá zadaný obsah literálu do ovládacího prvku. Tato metoda je volána rozhraním stránky ASP.NET.
AppendSubBuilder(ControlBuilder)	Přidá tvůrce do objektu ControlBuilder pro všechny podřízené ovládací prvky, které patří do ovládacího prvku kontejneru.
BuildObject()	Vytvoří instanci návrhu ovládacího prvku, na který odkazuje tento ControlBuilder objekt.
CloseControl()	Volal analyzátor, aby informoval tvůrce, že analýza otevírací a uzavírací značky ovládacího prvku je dokončena.
CreateBuilderFromType(TemplateParser, ControlBuilder, Type, String, String, IDictionary, Int32, String)	ControlBuilder Vytvoří objekt ze zadaného názvu značky a typu objektu a také další parametry definující tvůrce.
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
GetChildControlType(String, IDictionary)	Type Získá typ ovládacího prvku odpovídající podřízené značce. Tato metoda je volána rozhraním stránky ASP.NET.
GetHashCode()	Slouží jako výchozí hashovací funkce. (Zděděno od Object)
GetObjectPersistData()	ObjectPersistData Vytvoří objekt pro tento ControlBuilder objekt.
GetResourceKey()	Načte klíč prostředku pro tento ControlBuilder objekt.
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
HasBody()	Určuje, zda má ovládací prvek levou i uzavírací značku. Tato metoda je volána rozhraním stránky ASP.NET.
HtmlDecodeLiterals()	Určuje, zda literál řetězec ovládacího prvku HTML musí být dekódován HTML. Tato metoda je volána rozhraním stránky ASP.NET.
Init(TemplateParser, ControlBuilder, Type, String, String, IDictionary)	Inicializuje ControlBuilder pro použití po vytvoření instance. Tato metoda je volána rozhraním stránky ASP.NET.
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
NeedsTagInnerText()	Určuje, jestli tvůrce ovládacího prvku potřebuje získat vnitřní text. Pokud ano, SetTagInnerText(String) musí být volána metoda . Tato metoda je volána rozhraním stránky ASP.NET.
OnAppendToParentBuilder(ControlBuilder)	ControlBuilder Oznámí, že se přidává do tvůrce nadřazeného ovládacího prvku.
ProcessGeneratedCode(CodeCompileUnit, CodeTypeDeclaration, CodeTypeDeclaration, CodeMemberMethod, CodeMemberMethod)	Umožňuje vlastním tvůrcům ovládacích prvků přistupovat k vygenerovanému modelu Code Document Object Model (CodeDom) a vkládat a upravovat kód během procesu analýzy a sestavování ovládacích prvků.
SetResourceKey(String)	Nastaví klíč prostředku pro tento ControlBuilder objekt.
SetServiceProvider(IServiceProvider)	Nastaví objekt služby pro tento ControlBuilder objekt.
SetTagInnerText(String)	ControlBuilder Poskytuje vnitřní text značky ovládacího prvku.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Platí pro

Sdílet prostřednictvím