ControlDesigner Klasse

Definition

public ref class ControlDesigner : System::Web::UI::Design::HtmlControlDesigner

public class ControlDesigner : System.Web.UI.Design.HtmlControlDesigner

type ControlDesigner = class
    inherit HtmlControlDesigner

Public Class ControlDesigner
Inherits HtmlControlDesigner

Vererbung

Object

ComponentDesigner

HtmlControlDesigner

ControlDesigner

Abgeleitet

System.Web.DynamicData.Design.DynamicDataManagerDesigner

System.Web.UI.Design.ContainerControlDesigner

System.Web.UI.Design.DataSourceDesigner

System.Web.UI.Design.ExtenderControlDesigner

System.Web.UI.Design.HierarchicalDataSourceDesigner

Mehr …

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie eine einfache Designerklasse erstellt wird, die von der ControlDesigner -Klasse abgeleitet wird. Dieser Steuerelement-Designer unterstützt eine benutzerdefinierte TextControl Klasse und stellt einen Befehl bereit, um die Textgröße eines Steuerelements zur Entwurfszeit zu ändern. Der Steuerelement-Designer wird dem Steuerelement zugeordnet, indem er den Steuerelement-Designer in einer DesignerAttribute Objektdeklaration für die TextControl -Klasse angibt. Der Schlüssel zum Beibehalten von Eigenschaftenänderungen vom Steuerelement-Designer zum HTML-Markup befindet sich in der ToggleTextSize Methode der benutzerdefinierten ActionList Klasse.

Um das Beispiel zu testen, fügen Sie einen Verweis auf die System.Design.dll-Assembly hinzu, und kompilieren Sie den Code.

using System;
using System.Web.UI;
using System.Drawing;
using System.Web.UI.Design;
using System.Web.UI.WebControls;
using System.ComponentModel;
using System.ComponentModel.Design;

namespace ASPNet.Design.Samples.CS
{
    // Simple text Web control renders a text string.
    // This control is associated with the TextSizeWebControlDesigner.
    [DesignerAttribute(typeof(TextSizeWebControlDesigner)),
    ToolboxData("<{0}:TextControl runat=\"server\"></{0}:TextControl>")]
    public class TextControl : Label
    {
        private bool _largeText = true;

        // Constructor
        public TextControl()
        {
            Text = "Test Phrase";
            SetSize();
        }

        // Determines whether the text is large or small
        [Bindable(true), Category("Appearance"), DefaultValue("true")]
        public bool LargeText
        {
            get { return _largeText; }
            set
            {
                _largeText = value;
                SetSize();
            }
        }

        // Applies the LargeText property to the control
        private void SetSize()
        {
            if (LargeText)
                this.Font.Size = FontUnit.XLarge;
            else
                this.Font.Size = FontUnit.Small;
        }
    }

    // This control designer offers DesignerActionList commands
    // that can alter the design time html of the associated control.
    public class TextSizeWebControlDesigner : ControlDesigner
    {
        private DesignerActionListCollection _actionLists = null;

        // Do not allow direct resizing of the control
        public override bool AllowResize
        {
            get { return false; }
        }

        // Return a custom ActionList collection
        public override DesignerActionListCollection ActionLists
        {
            get
            {
                if (_actionLists == null)
                {
                    _actionLists = new DesignerActionListCollection();
                    _actionLists.AddRange(base.ActionLists);

                    // Add a custom DesignerActionList
                    _actionLists.Add(new ActionList(this));
                }
                return _actionLists;
            }
        }

        public class ActionList : DesignerActionList
        {
            private TextSizeWebControlDesigner _parent;
            private DesignerActionItemCollection _items;

            // Constructor
            public ActionList(TextSizeWebControlDesigner parent)
                : base(parent.Component)
            {
                _parent = parent;
            }

            // Create the ActionItem collection and add one command
            public override DesignerActionItemCollection GetSortedActionItems()
            {
                if (_items == null)
                {
                    _items = new DesignerActionItemCollection();
                    _items.Add(new DesignerActionMethodItem(this, "ToggleLargeText", "Toggle Text Size", true));
                }
                return _items;
            }

            // ActionList command to change the text size
            private void ToggleLargeText()
            {
                // Get a reference to the parent designer's associated control
                TextControl ctl = (TextControl)_parent.Component;

                // Get a reference to the control's LargeText property
                PropertyDescriptor propDesc = TypeDescriptor.GetProperties(ctl)["LargeText"];

                // Get the current value of the property
                bool v = (bool)propDesc.GetValue(ctl);

                // Toggle the property value
                propDesc.SetValue(ctl, !v);
            }
        }
    }
}

Imports System.Web.UI
Imports System.Web.UI.Design
Imports System.Web.UI.WebControls
Imports System.ComponentModel
Imports System.ComponentModel.Design

Namespace ASPNet.Design.Samples.VB

    ' Simple text Web control renders a text string.
    ' This control is associated with the TextSizeWebControlDesigner.
    <DesignerAttribute(GetType(TextSizeWebControlDesigner)), _
        ToolboxData("<{0}:TextControl runat='server'></{0}:TextControl>")> _
    Public Class TextControl
        Inherits Label

        Private _largeText As Boolean = True

        ' Constructor
        Public Sub New()
            Text = "Test Phrase"
            SetSize()
        End Sub

        ' Determines whether the text is large or small
        <Bindable(True), Category("Appearance"), DefaultValue(True)> _
        Public Property LargeText() As Boolean
            Get
                Return _largeText
            End Get
            Set(ByVal value As Boolean)
                _largeText = value
                SetSize()
            End Set
        End Property

        ' Applies the LargeText property to the control
        Private Sub SetSize()
            If LargeText Then
                Me.Font.Size = FontUnit.XLarge
            Else
                Me.Font.Size = FontUnit.Small
            End If
        End Sub
    End Class


    ' This control designer offers DesignerActionList commands
    ' that can alter the design time html of the associated control.
    Public Class TextSizeWebControlDesigner
        Inherits ControlDesigner

        Private _actionLists As DesignerActionListCollection

        ' Do not allow direct resizing of the control
        Public Overrides ReadOnly Property AllowResize() As Boolean
            Get
                Return False
            End Get
        End Property

        ' Return a custom ActionList collection
        Public Overrides ReadOnly Property ActionLists() As System.ComponentModel.Design.DesignerActionListCollection
            Get
                If IsNothing(_actionLists) Then
                    _actionLists = New DesignerActionListCollection()
                    _actionLists.AddRange(MyBase.ActionLists)

                    ' Add a custom DesignerActionList
                    _actionLists.Add(New ActionList(Me))
                End If

                Return _actionLists
            End Get
        End Property

        ' Create a custom class of DesignerActionList
        Public Class ActionList
            Inherits DesignerActionList
            Private _parent As TextSizeWebControlDesigner
            Private _items As DesignerActionItemCollection

            ' Constructor
            Public Sub New(ByRef parent As TextSizeWebControlDesigner)
                MyBase.New(parent.Component)
                _parent = parent
            End Sub

            ' Create the ActionItem collection and add one command
            Public Overrides Function GetSortedActionItems() As DesignerActionItemCollection
                If IsNothing(_items) Then
                    _items = New DesignerActionItemCollection()
                    _items.Add(New DesignerActionMethodItem(Me, "ToggleLargeText", "Toggle Text Size", True))
                End If

                Return _items
            End Function

            ' ActionList command to change the text size
            Private Sub ToggleLargeText()
                ' Get a reference to the parent designer's associated control
                Dim ctl As TextControl = CType(_parent.Component, TextControl)

                ' Get a reference to the control's LargeText property
                Dim propDesc As PropertyDescriptor = TypeDescriptor.GetProperties(ctl)("LargeText")

                ' Get the current value of the property
                Dim v As Boolean = CType(propDesc.GetValue(ctl), Boolean)
                ' Toggle the property value
                propDesc.SetValue(ctl, (Not v))
            End Sub
        End Class
    End Class
End Namespace

<%@ Page Language="C#" %>
<%@ Register TagPrefix="aspSample" 
    Namespace="ASPNet.Design.Samples.CS" %>
<!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>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    
    <aspSample:TextControl ID="TextControl1" runat="server">
    </aspSample:TextControl>

    
    </div>
    </form>
</body>
</html>

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

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    
        <aspSample:TextControl ID="TextControl1" runat="server">
        </aspSample:TextControl>
    
    </div>
    </form>
</body>
</html>

Hinweise

Die ControlDesigner -Klasse stellt eine Basissteuerelement-Designer-Klasse bereit, die von geerbt und erweitert werden kann, um Entwurfszeitunterstützung für ein Webserversteuerelement in einem Entwurfshost wie Visual Studio 2005 bereitzustellen.

Das Objektmodell für die Arbeit mit Entwurfszeitrendering wurde gegenüber früheren Versionen verbessert, wobei die folgenden neuen Basisklassen den Zugriff auf das vereinfachte Objektmodell ermöglichen:

• ControlDesigner, was nicht neu ist, aber stark verbessert wurde.

• ContainerControlDesigner.

• CompositeControlDesigner.

Automatische Formatierung

Sie können eine Vielzahl von automatischen und vordefinierten Formaten erstellen, die den Prozess von Seitenentwicklern vereinfachen können, die komplexe Stiländerungen auf benutzerdefinierte Webserversteuerelemente anwenden. Beispielsweise stellt das TableDesigner Steuerelement, das von der ControlDesigner -Klasse abgeleitet ist, viele automatische Formate bereit, aus denen sie auswählen können. Verwenden Sie die folgenden Features, um die automatische Formatierung in Ihren benutzerdefinierten Steuerelementen zu implementieren und bereitzustellen:

• Die AutoFormats-Eigenschaft

• Die OnAutoFormatApplied -Methode.

• Die DesignerAutoFormat-Klasse.

• Die DesignerAutoFormatStyle-Klasse.

Aktionslisten (Smarttags)

Aktionslisten sind Menüs mit wichtigen oder häufig verwendeten Aufgaben, die ein Seitenentwickler, der ein Steuerelement verwendet, in einer Entwurfszeit-Benutzeroberfläche wie Visual Studio 2005 ausführen kann. Beispielsweise kann die Entwurfszeitansicht Ihres Steuerelements ein Menü mit verfügbaren Aufgaben bereitstellen. Dazu gehört eine Aufgabe zum automatischen Formatieren des Steuerelements. Um mehr über Aktionslisten zu erfahren, beginnen Sie mit den folgenden Features:

• Die ActionLists-Eigenschaft

• Die DesignerActionList-Klasse.

• Die GetSortedActionItems -Methode.

• Die DesignerActionListCollection-Klasse.

• Die DesignerActionMethodItem-Klasse.

• Die DesignerActionPropertyItem-Klasse.

Steuerelement-Designer-Regionen

Regionen sind bearbeitbare Bereiche in der Entwurfszeitansicht eines Webserversteuerelements. Dieses Feature ermöglicht eine WYSIWYG-ähnliche Bearbeitung des Vorlageninhalts, der inneren Steuerelemente und der Eigenschaften zur Entwurfszeit. Sie können vom Steuerelement-Designer Steuerelemente in Regionen erstellen lassen, oder Sie können die Toolbox zum Ziehen und Ablegen von Steuerelementen in Regionen verwenden. Regionen werden mit den folgenden Features verwaltet:

• Die OnClick -Methode.

• Die DesignerRegion-Klasse.

• Die EditableDesignerRegion-Klasse.

• Die GetEditableDesignerRegionContent -Methode.

• Die SetEditableDesignerRegionContent -Methode.

Vorlagen

Das Modell zum Erstellen einer Benutzeroberfläche für die Entwurfszeitbearbeitung von vorlagenbasierten Steuerelementen, z. B. dem GridView -Steuerelement, wurde gegenüber früheren Versionen erheblich verbessert. Sie können komplexe benutzerdefinierte Steuerelemente erstellen, die Vorlagen für verschiedene Teile des Steuerelements enthalten, und Ihr designer für benutzerdefinierte Steuerelemente kann Seitenentwicklern helfen, die Vorlagen mit den folgenden Features ändern:

• Die TemplateGroups-Eigenschaft

• Die InTemplateMode-Eigenschaft

• Die TemplateGroup-Klasse.

Design-Time Rendering

Die ControlDesigner -Klasse verfügt über die folgenden Methoden, um das Entwurfszeitrendering des Webserversteuerelements zu unterstützen. Die meisten dieser Methoden sind mit denen in früheren Versionen identisch:

• Die GetDesignTimeHtml -Methode.

• Die GetEmptyDesignTimeHtml -Methode.

• Die GetErrorDesignTimeHtml -Methode.

• Die UpdateDesignTimeHtml -Methode.

• Die CreatePlaceHolderDesignTimeHtml -Methode.

Konstruktoren

Eigenschaften

Methoden

Explizite Schnittstellenimplementierungen

Gilt für:

Weitere Informationen

• TemplateGroup
• DesignerAutoFormat
• DesignerActionList
• DesignerRegion
• ContainerControlDesigner
• CompositeControlDesigner
• Einführung in ASP.NET Steuerelement-Designer
• Architektur der Entwurfszeit
• Beispielsteuerelement-Designer mit Aktionslisten und Diensten