ControlDesigner Klass

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

Arv

Object

ComponentDesigner

HtmlControlDesigner

ControlDesigner

Härledda

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

Mer…

Exempel

I följande kodexempel visas hur du skapar en enkel designerklass som härleds från ControlDesigner klassen. Den här kontrolldesignern stöder en anpassad TextControl klass och tillhandahåller ett kommando för att ändra textstorleken för en kontroll vid designtillfället. Kontrolldesignern är associerad med kontrollen genom att ange kontrolldesignern i en DesignerAttribute objektdeklaration för TextControl klassen. Nyckeln till att bevara egenskapsändringar från kontrolldesignern till HTML-markering finns i ToggleTextSize metoden för den anpassade ActionList klassen.

Om du vill prova exemplet lägger du till en referens till System.Design.dll sammansättning och kompilerar koden.

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>

Kommentarer

Klassen ControlDesigner tillhandahåller en baskontrolldesignerklass som kan ärvas från och utökas för att ge designtidsstöd för en webbserverkontroll i en designvärd, till exempel Visual Studio 2005.

Objektmodellen för att arbeta med designtidsrendering förbättras jämfört med tidigare versioner, med följande nya basklasser för att ge åtkomst till den förenklade objektmodellen:

• ControlDesigner, vilket inte är nytt, men har förbättrats avsevärt.

• ContainerControlDesigner.

• CompositeControlDesigner.

Automatisk formatering

Du kan skapa en mängd olika automatiska och fördefinierade format som kan förenkla processen för sidutvecklare som tillämpar komplexa formatändringar på anpassade webbserverkontroller. Kontrollen, som härleds från TableDesigner klassen, innehåller till exempel ControlDesigner många automatiska format att välja mellan. Använd följande funktioner för att implementera och tillhandahålla automatisk formatering i dina anpassade kontroller:

• Egenskapen AutoFormats.

• OnAutoFormatApplied-metoden.

• Klassen DesignerAutoFormat .

• Klassen DesignerAutoFormatStyle .

Åtgärdslistor (smarta taggar)

Åtgärdslistor är menyer med viktiga eller allmänt använda uppgifter som en sidutvecklare som använder en kontroll kan utföra i ett användargränssnitt (UI för designtid), till exempel Visual Studio 2005. Till exempel kan designtidsvyn för din kontroll ge en meny med tillgängliga uppgifter. Detta inkluderar en uppgift för att formatera kontrollen automatiskt. Om du vill veta mer om åtgärdslistor börjar du med följande funktioner:

• Egenskapen ActionLists.

• Klassen DesignerActionList .

• GetSortedActionItems-metoden.

• Klassen DesignerActionListCollection .

• Klassen DesignerActionMethodItem .

• Klassen DesignerActionPropertyItem .

Kontrolldesignerregioner

Regioner är redigerbara områden i designtidsvyn för en webbserverkontroll. Den här funktionen erbjuder WYSIWYG-liknande redigering av mallinnehåll, inre kontroller och egenskaper vid designtillfället. Du kan låta kontrolldesignern skapa kontroller i regioner eller använda verktygslådan för att dra och släppa kontroller till regioner. Regioner hanteras med följande funktioner:

• OnClick-metoden.

• Klassen DesignerRegion .

• Klassen EditableDesignerRegion .

• GetEditableDesignerRegionContent-metoden.

• SetEditableDesignerRegionContent-metoden.

Templates

Modellen för att skapa ett användargränssnitt för designtidsredigering av mallade kontroller, till exempel GridView kontrollen, har förbättrats avsevärt från tidigare versioner. Du kan skapa komplexa anpassade kontroller som innehåller mallar för olika delar av kontrollen, och din anpassade kontrolldesigner kan hjälpa sidutvecklare som ändrar mallar med följande funktioner:

• Egenskapen TemplateGroups.

• Egenskapen InTemplateMode.

• Klassen TemplateGroup .

Design-Time rendering

Klassen ControlDesigner har följande metoder för att stödja designtidsåtergivning av webbserverkontrollen. De flesta av dessa metoder är desamma som i tidigare versioner:

• GetDesignTimeHtml-metoden.

• GetEmptyDesignTimeHtml-metoden.

• GetErrorDesignTimeHtml-metoden.

• UpdateDesignTimeHtml-metoden.

• CreatePlaceHolderDesignTimeHtml-metoden.

Se även

• TemplateGroup
• DesignerAutoFormat
• DesignerActionList
• DesignerRegion
• ContainerControlDesigner
• CompositeControlDesigner
• Introduction till ASP.NET Control Designers
• Design-Time Arkitektur
• Exempel på Kontrolldesigner med åtgärdslistor och tjänster