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 a seguir demonstra como criar uma classe de designer simples derivada da ControlDesigner classe . Esse designer de controle dá suporte a uma classe personalizada TextControl e fornece um comando para alterar o tamanho do texto de um controle em tempo de design. O designer de controle é associado ao controle especificando o designer de controle em uma DesignerAttribute declaração de objeto na TextControl classe . A chave para manter as alterações de propriedade do designer de controle para a marcação HTML é encontrada no ToggleTextSize método da classe personalizada ActionList .

Para experimentar o exemplo, adicione uma referência ao assembly System.Design.dll 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>

Comentários

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

O modelo de objeto para trabalhar com a renderização em tempo de design é aprimorado em versões anteriores, com as seguintes novas classes base para fornecer acesso ao modelo de objeto simplificado:

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

• ContainerControlDesigner.

• CompositeControlDesigner.

Formatação automática

Você pode criar uma variedade de formatos automáticos e predefinidos que podem simplificar o processo de desenvolvedores de páginas que estão aplicando alterações de estilo complexas a controles de servidor Web personalizados. Por exemplo, o TableDesigner controle, que deriva da ControlDesigner classe , fornece muitos formatos automáticos dos quais escolher. Para implementar e fornecer formatação automática em seus controles personalizados, use os seguintes recursos:

• A propriedade de AutoFormats .

• O método OnAutoFormatApplied.

• A classe DesignerAutoFormat.

• A classe DesignerAutoFormatStyle.

Listas de ações (marcas inteligentes)

Listas de ações são menus de tarefas importantes ou amplamente usadas que um desenvolvedor de páginas que usa um controle pode executar em uma interface do usuário em tempo de design, como o Visual Studio 2005. Por exemplo, a exibição de tempo de design do controle pode fornecer um menu de tarefas disponíveis. Isso inclui uma tarefa para formatar o controle automaticamente. Para saber mais sobre listas de ações, comece com os seguintes recursos:

• A propriedade de ActionLists .

• A classe DesignerActionList.

• O método GetSortedActionItems.

• A classe DesignerActionListCollection.

• A classe DesignerActionMethodItem.

• A classe DesignerActionPropertyItem.

Regiões de designer de controle

As regiões são áreas editáveis na exibição de tempo de design de um controle de servidor Web. Esse recurso oferece edição semelhante a WYSIWYG do conteúdo do modelo, controles internos e propriedades em tempo de design. Você pode fazer com que o designer de controle crie controles em regiões ou use a Caixa de Ferramentas para arrastar e soltar controles para regiões. As regiões são gerenciadas com os seguintes recursos:

• O método OnClick.

• A classe DesignerRegion.

• A classe EditableDesignerRegion.

• O método GetEditableDesignerRegionContent.

• O método SetEditableDesignerRegionContent.

Modelos

O modelo para criar uma interface do usuário para edição em tempo de design de controles modelo, como o GridView controle, foi muito aprimorado em relação a versões anteriores. Você pode criar controles personalizados complexos que incluem modelos para várias partes do controle e seu designer de controle personalizado pode ajudar os desenvolvedores de páginas que estão modificando modelos com os seguintes recursos:

• A propriedade de TemplateGroups .

• A propriedade de InTemplateMode .

• A classe TemplateGroup.

Processamento de tempo de design

A ControlDesigner classe tem os seguintes métodos para dar suporte à renderização em tempo de design do controle do servidor Web. A maioria desses métodos é a mesma de versões anteriores:

• O método GetDesignTimeHtml.

• O método GetEmptyDesignTimeHtml.

• O método GetErrorDesignTimeHtml.

• O método UpdateDesignTimeHtml.

• O método CreatePlaceHolderDesignTimeHtml.

Construtores

Propriedades

Métodos

Implantações explícitas de interface

Aplica-se a

Confira também

• TemplateGroup
• DesignerAutoFormat
• DesignerActionList
• DesignerRegion
• ContainerControlDesigner
• CompositeControlDesigner
• Introdução aos Designers de Controle de ASP.NET
• Arquitetura de tempo de design
• Designer de controle de exemplo com listas de ações e serviços