ControlDesigner Класс

Определение

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

Наследование

Object

ComponentDesigner

HtmlControlDesigner

ControlDesigner

Производный

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

Подробнее…

Примеры

В следующем примере кода показано, как создать простой класс конструктора, производный ControlDesigner от класса . Этот конструктор элементов управления поддерживает пользовательский TextControl класс и предоставляет команду для изменения размера текста элемента управления во время разработки. Конструктор элементов управления связывается с элементом управления путем указания конструктора элемента управления в объявлении DesignerAttribute объекта класса TextControl . Ключ для сохранения изменений свойств из конструктора элементов управления в разметку HTML находится в ToggleTextSize методе пользовательского ActionList класса.

Чтобы попробовать пример, добавьте ссылку на сборку System.Design.dll и скомпилируйте код.

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>

Комментарии

Класс ControlDesigner предоставляет класс конструктора базовых элементов управления, который можно наследовать от и расширить для обеспечения поддержки серверного веб-элемента управления в узле разработки, например Visual Studio 2005.

Объектная модель для работы с отрисовкой во время разработки улучшена по сравнению с более ранними версиями с использованием следующих новых базовых классов для предоставления доступа к упрощенной объектной модели:

• ControlDesigner, которая не является новой, но была значительно улучшена.

• ContainerControlDesigner.

• CompositeControlDesigner.

Автоматическое форматирование

Вы можете создать различные автоматические и предварительно определенные форматы, которые могут упростить процесс разработчиков страниц, которые применяют сложные изменения стиля к пользовательским элементам управления веб-сервера. Например, TableDesigner элемент управления, производный ControlDesigner от класса , предоставляет множество автоматических форматов для выбора. Чтобы реализовать и обеспечить автоматическое форматирование в пользовательских элементах управления, используйте следующие функции:

• Свойство AutoFormats.

• метод OnAutoFormatApplied ;

• Класс DesignerAutoFormat.

• Класс DesignerAutoFormatStyle.

Списки действий (смарт-теги)

Списки действий — это меню важных или широко используемых задач, которые разработчик страницы, использующий элемент управления, может выполнять в пользовательском интерфейсе времени разработки, например Visual Studio 2005. Например, представление времени разработки элемента управления может предоставлять меню доступных задач. Сюда входит задача автоматического форматирования элемента управления. Чтобы узнать о списках действий, начните со следующих функций:

• Свойство ActionLists.

• Класс DesignerActionList.

• метод GetSortedActionItems ;

• Класс DesignerActionListCollection.

• Класс DesignerActionMethodItem.

• Класс DesignerActionPropertyItem.

Регионы конструктора элементов управления

Регионы — это редактируемые области во время разработки серверного веб-элемента управления. Эта функция обеспечивает WYSIWYG-подобное редактирование содержимого шаблона, внутренних элементов управления и свойств во время разработки. Конструктор элементов управления может создавать элементы управления в регионах или использовать панель элементов для перетаскивания элементов в регионы. Управление регионами осуществляется со следующими функциями:

• метод OnClick ;

• Класс DesignerRegion.

• Класс EditableDesignerRegion.

• метод GetEditableDesignerRegionContent ;

• метод SetEditableDesignerRegionContent ;

Шаблоны

Модель создания пользовательского интерфейса для редактирования шаблонных элементов управления во время разработки, таких как GridView элемент управления, была значительно улучшена по мере использования более ранних версий. Вы можете создавать сложные настраиваемые элементы управления, включающие шаблоны для различных частей элемента управления, а конструктор пользовательских элементов управления может помочь разработчикам страниц, изменяющим шаблоны, со следующими функциями:

• Свойство TemplateGroups.

• Свойство InTemplateMode.

• Класс TemplateGroup.

Отрисовка Design-Time

Класс ControlDesigner имеет следующие методы для поддержки отрисовки веб-серверного элемента управления во время разработки. Большинство из этих методов те же, что и в более ранних версиях:

• метод GetDesignTimeHtml ;

• метод GetEmptyDesignTimeHtml ;

• метод GetErrorDesignTimeHtml ;

• метод UpdateDesignTimeHtml ;

• метод CreatePlaceHolderDesignTimeHtml ;

Конструкторы

Свойства

Методы

Явные реализации интерфейса

Применяется к

См. также раздел

• TemplateGroup
• DesignerAutoFormat
• DesignerActionList
• DesignerRegion
• ContainerControlDesigner
• CompositeControlDesigner
• Общие сведения о конструкторах элементов управления ASP.NET
• Архитектура времени разработки
• Пример конструктора элементов управления со списками действий и службами