ControlDesigner Classe

Definição

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

Herança

Object

ComponentDesigner

HtmlControlDesigner

ControlDesigner

Derivado

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

Mais…

Exemplos

O exemplo de código seguinte demonstra como criar uma classe designer simples que deriva da ControlDesigner classe. Este designer de controlos suporta uma classe personalizada TextControl e fornece um comando para alterar o tamanho do texto de um controlo no momento do design. O designer de controlo está associado ao controlo especificando o designer de controlo numa DesignerAttribute declaração de objeto na TextControl classe. A chave para persistir alterações de propriedades desde o designer de controlos até à marcação HTML encontra-se no ToggleTextSize método da classe personalizada ActionList .

Para tentar o exemplo, adicione uma referência à System.Design.dll assembly e compile o código.

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>

Observações

A classe ControlDesigner fornece uma classe base de designer de controlo que pode ser herdada e estendida para fornecer suporte em tempo de projeto para um controlo de servidor Web num host de design, como Visual Studio 2005.

O modelo de objetos para trabalhar com renderização em tempo de design foi melhorado em relação às versões anteriores, com as seguintes novas classes base para fornecer acesso ao modelo de objeto simplificado:

• ControlDesigner, o que não é novo, mas foi muito melhorado.

• ContainerControlDesigner.

• CompositeControlDesigner.

Formatação Automática

Pode criar uma variedade de formatos automáticos e pré-definidos que simplificam o processo dos programadores de páginas que aplicam alterações complexas de estilo a controlos personalizados de servidores Web. Por exemplo, o TableDesigner controlo, que deriva da ControlDesigner classe, fornece muitos formatos automáticos para escolher. Para implementar e fornecer formatação automática nos seus controlos personalizados, utilize as seguintes funcionalidades:

• A propriedade AutoFormats.

• O método OnAutoFormatApplied.

• A DesignerAutoFormat classe.

• A DesignerAutoFormatStyle classe.

Listas de Ações (Smart Tags)

As listas de ações são menus de tarefas importantes ou amplamente utilizadas que um programador de páginas que utiliza um controlo pode realizar numa interface de utilizador (UI) em tempo de design, como o Visual Studio 2005. Por exemplo, a vista em tempo de design do seu controlo pode fornecer um menu de tarefas disponíveis. Isto inclui uma tarefa para formatar automaticamente o controlo. Para aprender sobre listas de ações, comece pelas seguintes funcionalidades:

• A propriedade ActionLists.

• A DesignerActionList classe.

• O método GetSortedActionItems.

• A DesignerActionListCollection classe.

• A DesignerActionMethodItem classe.

• A DesignerActionPropertyItem classe.

Regiões do Designer de Controlo

As regiões são áreas editáveis na vista de design time de um controlo de servidor Web. Esta funcionalidade oferece edição semelhante a WYSIWYG do conteúdo do modelo, controlos internos e propriedades no momento do design. Podes pedir ao designer de controlos para criar controlos em regiões ou podes usar a Toolbox para arrastar e largar controlos dentro das regiões. As regiões são geridas com as seguintes características:

• O método OnClick.

• A DesignerRegion classe.

• A EditableDesignerRegion classe.

• O método GetEditableDesignerRegionContent.

• O método SetEditableDesignerRegionContent.

Templates

O modelo para criar uma interface de utilizador para edição em tempo de design de controlos templateados, como o controlo GridView , foi muito melhorado em relação às versões anteriores. Pode criar controlos personalizados complexos que incluem modelos para várias partes do controlo, e o seu designer de controlos personalizados pode ajudar os programadores de páginas que estão a modificar modelos com as seguintes funcionalidades:

• A propriedade TemplateGroups.

• A propriedade InTemplateMode.

• A TemplateGroup classe.

Design-Time Renderização

A ControlDesigner classe tem os seguintes métodos para suportar a renderização em tempo de design do controlo do servidor Web. A maioria destes métodos é a mesma das versões anteriores:

• O método GetDesignTimeHtml.

• O método GetEmptyDesignTimeHtml.

• O método GetErrorDesignTimeHtml.

• O método UpdateDesignTimeHtml.

• O método CreatePlaceHolderDesignTimeHtml.

Ver também

• TemplateGroup
• DesignerAutoFormat
• DesignerActionList
• DesignerRegion
• ContainerControlDesigner
• CompositeControlDesigner
• Introdução aos Designers de Controlo ASP.NET
• ArquiteturaDesign-Time
• Designer de Controlo de Exemplos com Listas de Ações e Serviços