ControlBuilder Classe

  • Référence

Définition

Espace de noms:
System.Web.UI
Assembly:
System.Web.dll

Prend l'analyseur de page en charge en générant un contrôle et les contrôles enfants qu'il contient.

public ref class ControlBuilder
public class ControlBuilder
type ControlBuilder = class
Public Class ControlBuilder
Héritage
Object
ControlBuilder
Dérivé

Exemples

L’exemple de code suivant crée un Table contrôle dont les attributs et le contenu sont définis au moment de la création de la table. Voici la ligne de commande à utiliser pour générer l’exécutable.

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

L’exemple de code suivant utilise le contrôle personnalisé précédent. En particulier, il génère une table dont les attributs et le contenu sont définis au moment de l’exécution. Notez que les valeurs affichées dans la directive @ Register reflètent la ligne de commande précédente.

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

Remarques

Par défaut, chaque contrôle d’une page est associé à une classe par défaut ControlBuilder . Pendant l’analyse, l’infrastructure de page ASP.NET génère une arborescence d’objets ControlBuilder correspondant à l’arborescence des contrôles de la page. L’arborescence ControlBuilder est ensuite utilisée pour générer le code de page afin de créer l’arborescence de contrôle. Outre les contrôles enfants, le ControlBuilder définit le comportement de l’analyse du contenu dans les balises de contrôle. Vous pouvez remplacer ce comportement par défaut en définissant votre propre classe de générateur de contrôles personnalisé. Pour ce faire, appliquez un ControlBuilderAttribute attribut à votre classe de générateur de contrôles comme suit :

[ControlBuilderAttribute(typeof(ControlBuilderType))]

Constructeurs

ControlBuilder()

Initialise une nouvelle instance de la classe ControlBuilder.

Champs

DesignerFilter

Représente la "__designer" chaîne littérale.

Propriétés

BindingContainerBuilder

Obtient le générateur de contrôles qui correspond au conteneur de liaison pour le contrôle que ce concepteur crée.
BindingContainerType

Reçoit le type du conteneur de liaison pour le contrôle que ce générateur crée.
ComplexPropertyEntries

Obtient une collection d'entrées de propriétés complexes.
ControlType

Obtient Type pour le contrôle à créer.
CurrentFilterResolutionService

Obtient un objet IFilterResolutionService utilisé pour gérer des services liés au filtre pour appareil mobile lorsque des contrôles sont analysés et rendus persistants dans le concepteur.
DeclareType

Obtient le type qui sera utilisé par la génération de code pour déclarer le contrôle.
FChildrenAsProperties

Obtient une valeur qui détermine si le contrôle a ParseChildrenAttribute avec ChildrenAsProperties défini sur true.
FIsNonParserAccessor

Obtient une valeur qui détermine si le contrôle implémente l'interface IParserAccessor.
HasAspCode

Obtient une valeur indiquant si le contrôle contient des blocs de code.
ID

Obtient ou définit la propriété identificateur du contrôle à générer.
InDesigner

Retourne si ControlBuilder s'exécute dans le concepteur.
InPageTheme

Obtient une valeur Boolean qui indique si cet objet ControlBuilder est utilisé pour générer des thèmes de page.
ItemType

Obtient le type défini sur le conteneur de liaison.
Localize

Obtient une valeur Boolean qui indique si le contrôle créé par cet objet ControlBuilder est localisé.
NamingContainerType

Reçoit le type du conteneur d'attribution de noms pour le contrôle que ce générateur crée.
PageVirtualPath

Obtient le chemin d'accès virtuel d'une page qui doit être générée par cette instance de ControlBuilder.
Parser

Obtient le TemplateParser responsable de l'analyse du contrôle.
ServiceProvider

Obtient l'objet de service pour cet objet ControlBuilder.
SubBuilders

Obtient une liste d'objets ControlBuilder enfants pour cet objet ControlBuilder.
TagName

Obtient le nom de la balise pour le contrôle à générer.
TemplatePropertyEntries

Obtient une collection d'entrées de propriétés de modèle.
ThemeResolutionService

Obtient un objet IThemeResolutionService utilisé au moment du design pour gérer des thèmes et des apparences de contrôle.

Méthodes

AllowWhitespaceLiterals()

Détermine si les littéraux d’espace blanc sont autorisés dans le contenu entre les balises d’ouverture et de fermeture d’un contrôle. Cette méthode est appelée par l’infrastructure de page ASP.NET.
AppendLiteralString(String)

Ajoute le contenu littéral spécifié à un contrôle. Cette méthode est appelée par l’infrastructure de page ASP.NET.
AppendSubBuilder(ControlBuilder)

Ajoute des générateurs à l’objet ControlBuilder pour les contrôles enfants qui appartiennent au contrôle conteneur.
BuildObject()

Génère au moment du design une instance du contrôle référencé par cet objet ControlBuilder.
CloseControl()

Appelé par l'analyseur pour informer le générateur que l'analyse des balises d'ouverture et de fermeture du contrôle est terminée.
CreateBuilderFromType(TemplateParser, ControlBuilder, Type, String, String, IDictionary, Int32, String)

Crée un objet ControlBuilder à partir du nom de balise et du type d'objet spécifiés, et d'autres paramètres qui définissent le générateur.
Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.

(Hérité de Object)
GetChildControlType(String, IDictionary)

Obtient le Type du type de contrôle qui correspond à une balise enfant. Cette méthode est appelée par l’infrastructure de page ASP.NET.
GetHashCode()

Fait office de fonction de hachage par défaut.

(Hérité de Object)
GetObjectPersistData()

Crée l'objet ObjectPersistData pour cet objet ControlBuilder.
GetResourceKey()

Récupère la clé de ressource pour cet objet ControlBuilder.
GetType()

Obtient le Type de l'instance actuelle.

(Hérité de Object)
HasBody()

Détermine si un contrôle a les deux balises, d'ouverture et de fermeture. Cette méthode est appelée par l’infrastructure de page ASP.NET.
HtmlDecodeLiterals()

Détermine si la chaîne littérale d'un contrôle HTML doit être décodée en HTML. Cette méthode est appelée par l’infrastructure de page ASP.NET.
Init(TemplateParser, ControlBuilder, Type, String, String, IDictionary)

Initialise le ControlBuilder pour l'utiliser après son instanciation. Cette méthode est appelée par l’infrastructure de page ASP.NET.
MemberwiseClone()

Crée une copie superficielle du Object actuel.

(Hérité de Object)
NeedsTagInnerText()

Détermine si le générateur de contrôles a besoin d'obtenir son texte interne. Si c'est le cas, il faut appeler la méthode SetTagInnerText(String). Cette méthode est appelée par l’infrastructure de page ASP.NET.
OnAppendToParentBuilder(ControlBuilder)

Avertit ControlBuilder qu'il s'ajoute à un générateur de contrôles parent.
ProcessGeneratedCode(CodeCompileUnit, CodeTypeDeclaration, CodeTypeDeclaration, CodeMemberMethod, CodeMemberMethod)

Permet aux générateurs de contrôles personnalisés d'accéder au modèle CodeDom (Code Document Object Model) généré, ainsi que d'insérer et de modifier du code au cours du processus d'analyse et de génération des contrôles.
SetResourceKey(String)

Définit la clé de ressource pour cet objet ControlBuilder.
SetServiceProvider(IServiceProvider)

Définit l'objet de service pour cet objet ControlBuilder.
SetTagInnerText(String)

Fournit à ControlBuilder le texte interne de la balise du contrôle.
ToString()

Retourne une chaîne qui représente l'objet actuel.

(Hérité de Object)

S’applique à

Voir aussi