ControlBuilder Klasa

  • Odwołanie

Definicja

Przestrzeń nazw:
System.Web.UI
Zestaw:
System.Web.dll

Obsługuje analizator stron podczas tworzenia kontrolki i kontrolek podrzędnych, które zawiera.

public ref class ControlBuilder
public class ControlBuilder
type ControlBuilder = class
Public Class ControlBuilder
Dziedziczenie
Object
ControlBuilder
Pochodne

Przykłady

Poniższy przykład kodu tworzy kontrolkę Table , której atrybuty i zawartość są definiowane w czasie tworzenia tabeli. Poniżej przedstawiono wiersz polecenia używany do kompilowania pliku wykonywalnego.

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

Poniższy przykład kodu używa poprzedniej kontrolki niestandardowej. W szczególności tworzy tabelę, której atrybuty i zawartość są definiowane w czasie wykonywania. Zwróć uwagę, że wartości wyświetlane w dyrektywie @ Register odzwierciedlają poprzedni wiersz polecenia.

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

Uwagi

Domyślnie każda kontrolka na stronie jest skojarzona z klasą domyślną ControlBuilder . Podczas analizowania struktura strony ASP.NET tworzy drzewo ControlBuilder obiektów odpowiadających drzewu kontrolek dla strony. Drzewo ControlBuilder jest następnie używane do generowania kodu strony w celu utworzenia drzewa sterującego. Oprócz kontrolek ControlBuilder podrzędnych definiuje zachowanie sposobu analizowania zawartości w ramach tagów kontrolek. To domyślne zachowanie można zastąpić, definiując własną niestandardową klasę konstruktora kontrolek. W tym celu należy zastosować ControlBuilderAttribute atrybut do klasy konstruktora kontrolek w następujący sposób:

[ControlBuilderAttribute(typeof(ControlBuilderType))]

Konstruktory

ControlBuilder()

Inicjuje nowe wystąpienie klasy ControlBuilder.

Pola

DesignerFilter

"__designer" Reprezentuje ciąg literału.

Właściwości

BindingContainerBuilder

Pobiera konstruktora kontrolek, który odpowiada kontenerowi powiązania dla kontrolki tworzonej przez tego konstruktora.
BindingContainerType

Pobiera typ kontenera powiązania dla kontrolki tworzonej przez tego konstruktora.
ComplexPropertyEntries

Pobiera kolekcję złożonych wpisów właściwości.
ControlType

Pobiera kontrolkę Type do utworzenia.
CurrentFilterResolutionService

IFilterResolutionService Pobiera obiekt używany do zarządzania usługami powiązanymi z filtrowaniem urządzeń podczas analizowania i utrwalania kontrolek w projektancie.
DeclareType

Pobiera typ, który będzie używany przez generowanie kodu w celu zadeklarowania kontrolki.
FChildrenAsProperties

Pobiera wartość określającą, czy kontrolka ma wartość z ustawioną wartością ParseChildrenAttributeChildrenAsPropertiestrue.
FIsNonParserAccessor

Pobiera wartość określającą, czy kontrolka implementuje IParserAccessor interfejs.
HasAspCode

Pobiera wartość wskazującą, czy kontrolka zawiera jakiekolwiek bloki kodu.
ID

Pobiera lub ustawia właściwość identyfikatora kontrolki do skompilowania.
InDesigner

Zwraca, ControlBuilder czy element jest uruchomiony w projektancie.
InPageTheme

Pobiera wartość logiczną wskazującą, czy ten ControlBuilder obiekt jest używany do generowania motywów stron.
ItemType

Pobiera typ ustawiony w kontenerze powiązania.
Localize

Pobiera wartość logiczną wskazującą, czy kontrolka utworzona przez ten ControlBuilder obiekt jest zlokalizowana.
NamingContainerType

Pobiera typ kontenera nazewnictwa dla kontrolki tworzonej przez tego konstruktora.
PageVirtualPath

Pobiera ścieżkę wirtualną strony do skompilowania przez to ControlBuilder wystąpienie.
Parser

TemplateParser Pobiera element odpowiedzialny za analizowanie kontrolki.
ServiceProvider

Pobiera obiekt usługi dla tego ControlBuilder obiektu.
SubBuilders

Pobiera listę obiektów podrzędnych ControlBuilder dla tego ControlBuilder obiektu.
TagName

Pobiera nazwę tagu kontrolki do skompilowania.
TemplatePropertyEntries

Pobiera kolekcję wpisów właściwości szablonu.
ThemeResolutionService

IThemeResolutionService Pobiera obiekt, który jest używany w czasie projektowania do zarządzania motywami i skórami sterowania.

Metody

AllowWhitespaceLiterals()

Określa, czy literały odstępu są dozwolone w zawartości między znacznikami otwierania i zamykania kontrolki. Ta metoda jest wywoływana przez platformę stron ASP.NET.
AppendLiteralString(String)

Dodaje określoną zawartość literału do kontrolki. Ta metoda jest wywoływana przez platformę stron ASP.NET.
AppendSubBuilder(ControlBuilder)

Dodaje konstruktorów do ControlBuilder obiektu dla wszystkich kontrolek podrzędnych należących do kontrolki kontenera.
BuildObject()

Tworzy wystąpienie kontrolki w czasie projektowania, do którego odwołuje się ten ControlBuilder obiekt.
CloseControl()

Wywołana przez analizator, aby poinformować konstruktora, że analizowanie tagów otwierania i zamykania kontrolki jest zakończone.
CreateBuilderFromType(TemplateParser, ControlBuilder, Type, String, String, IDictionary, Int32, String)

ControlBuilder Tworzy obiekt na podstawie określonej nazwy tagu i typu obiektu, a także innych parametrów definiujących konstruktora.
Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.

(Odziedziczone po Object)
GetChildControlType(String, IDictionary)

Type Uzyskuje typ kontrolki odpowiadający tagowi podrzędnego. Ta metoda jest wywoływana przez platformę stron ASP.NET.
GetHashCode()

Służy jako domyślna funkcja skrótu.

(Odziedziczone po Object)
GetObjectPersistData()

ObjectPersistData Tworzy obiekt dla tego ControlBuilder obiektu.
GetResourceKey()

Pobiera klucz zasobu dla tego ControlBuilder obiektu.
GetType()

Type Pobiera bieżące wystąpienie.

(Odziedziczone po Object)
HasBody()

Określa, czy kontrolka ma zarówno tag otwierający, jak i zamykający. Ta metoda jest wywoływana przez platformę stron ASP.NET.
HtmlDecodeLiterals()

Określa, czy ciąg literału kontrolki HTML musi być zdekodowany w formacie HTML. Ta metoda jest wywoływana przez platformę stron ASP.NET.
Init(TemplateParser, ControlBuilder, Type, String, String, IDictionary)

Inicjuje element do użycia po utworzeniu ControlBuilder wystąpienia. Ta metoda jest wywoływana przez platformę stron ASP.NET.
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
NeedsTagInnerText()

Określa, czy konstruktor kontrolki musi uzyskać jego tekst wewnętrzny. Jeśli tak, należy wywołać metodę SetTagInnerText(String) . Ta metoda jest wywoływana przez platformę stron ASP.NET.
OnAppendToParentBuilder(ControlBuilder)

ControlBuilder Powiadamia o tym, że jest on dodawany do nadrzędnego konstruktora kontrolek.
ProcessGeneratedCode(CodeCompileUnit, CodeTypeDeclaration, CodeTypeDeclaration, CodeMemberMethod, CodeMemberMethod)

Umożliwia niestandardowym konstruktorom kontrolek uzyskiwanie dostępu do wygenerowanego modelu obiektów dokumentów kodu (CodeDom) oraz wstawianie i modyfikowanie kodu podczas procesu analizowania i kompilowania kontrolek.
SetResourceKey(String)

Ustawia klucz zasobu dla tego ControlBuilder obiektu.
SetServiceProvider(IServiceProvider)

Ustawia obiekt usługi dla tego ControlBuilder obiektu.
SetTagInnerText(String)

ControlBuilder Zawiera tekst wewnętrzny tagu kontrolki.
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Dotyczy

Zobacz też