ControlDesigner Classe

Définition

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

Héritage

Object

ComponentDesigner

HtmlControlDesigner

ControlDesigner

Dérivé

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

Plus…

Exemples

L’exemple de code suivant montre comment créer une classe de concepteur simple qui dérive de la ControlDesigner classe . Ce concepteur de contrôles prend en charge une classe personnalisée TextControl et fournit une commande pour modifier la taille du texte d’un contrôle au moment de la conception. Le concepteur de contrôles est associé au contrôle en spécifiant le concepteur de contrôles dans une déclaration d’objet DesignerAttribute sur la TextControl classe . La clé permettant de conserver les modifications de propriété du concepteur de contrôles vers le balisage HTML se trouve dans la ToggleTextSize méthode de la classe personnalisée ActionList .

Pour essayer l’exemple, ajoutez une référence à l’assembly System.Design.dll et compilez le 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>

Remarques

La ControlDesigner classe fournit une classe de concepteur de contrôles de base qui peut être héritée de et étendue pour fournir une prise en charge au moment de la conception d’un contrôle serveur Web dans un hôte de conception, tel que Visual Studio 2005.

Le modèle objet permettant d’utiliser le rendu au moment du design est amélioré par rapport aux versions antérieures, avec les nouvelles classes de base suivantes pour fournir l’accès au modèle objet simplifié :

• ControlDesigner, qui n’est pas nouveau, mais qui a été considérablement amélioré.

• ContainerControlDesigner.

• CompositeControlDesigner.

Mise en forme automatique

Vous pouvez créer une variété de formats automatiques et prédéfinis qui peuvent simplifier le processus des développeurs de pages qui appliquent des modifications de style complexes aux contrôles de serveur Web personnalisés. Par exemple, le TableDesigner contrôle, qui dérive de la ControlDesigner classe , fournit de nombreux formats automatiques à partir desquels choisir. Pour implémenter et fournir une mise en forme automatique dans vos contrôles personnalisés, utilisez les fonctionnalités suivantes :

• La propriété AutoFormats.

• Méthode OnAutoFormatApplied

• La classe DesignerAutoFormat.

• La classe DesignerAutoFormatStyle.

Listes d’actions (balises actives)

Les listes d’actions sont des menus de tâches importantes ou largement utilisées qu’un développeur de pages qui utilise un contrôle peut effectuer dans une interface utilisateur au moment du design, telle que Visual Studio 2005. Par exemple, la vue au moment du design de votre contrôle peut fournir un menu des tâches disponibles. Cela inclut une tâche de mise en forme automatique du contrôle. Pour en savoir plus sur les listes d’actions, commencez par les fonctionnalités suivantes :

• La propriété ActionLists.

• La classe DesignerActionList.

• Méthode GetSortedActionItems

• La classe DesignerActionListCollection.

• La classe DesignerActionMethodItem.

• La classe DesignerActionPropertyItem.

Contrôler Designer régions

Les régions sont des zones modifiables dans l’affichage au moment de la conception d’un contrôle serveur Web. Cette fonctionnalité offre une modification de type WYSIWYG du contenu du modèle, des contrôles internes et des propriétés au moment de la conception. Le concepteur de contrôles peut créer des contrôles dans des régions ou utiliser la boîte à outils pour glisser-déplacer des contrôles dans des régions. Les régions sont gérées avec les fonctionnalités suivantes :

• Méthode OnClick

• La classe DesignerRegion.

• La classe EditableDesignerRegion.

• Méthode GetEditableDesignerRegionContent

• Méthode SetEditableDesignerRegionContent

Modèles

Le modèle de création d’une interface utilisateur pour la modification au moment du design des contrôles modélisés, tels que le GridView contrôle, a été considérablement amélioré par les versions antérieures. Vous pouvez créer des contrôles personnalisés complexes qui incluent des modèles pour différentes parties du contrôle, et votre concepteur de contrôles personnalisé peut aider les développeurs de pages qui modifient des modèles avec les fonctionnalités suivantes :

• La propriété TemplateGroups.

• La propriété InTemplateMode.

• La classe TemplateGroup.

rendu Design-Time

La ControlDesigner classe a les méthodes suivantes pour prendre en charge le rendu au moment du design du contrôle serveur Web. La plupart de ces méthodes sont les mêmes que dans les versions antérieures :

• Méthode GetDesignTimeHtml

• Méthode GetEmptyDesignTimeHtml

• Méthode GetErrorDesignTimeHtml

• Méthode UpdateDesignTimeHtml

• Méthode CreatePlaceHolderDesignTimeHtml

Constructeurs

Propriétés

Méthodes

Implémentations d’interfaces explicites

S’applique à

Voir aussi

• TemplateGroup
• DesignerAutoFormat
• DesignerActionList
• DesignerRegion
• ContainerControlDesigner
• CompositeControlDesigner
• Présentation des concepteurs de contrôle ASP.NET
• Architecture de design
• Exemple de Designer de contrôle avec des listes d’actions et des services