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 マークアップへのプロパティ変更を永続化するためのキーは、カスタム ActionList クラスの メソッドにありますToggleTextSize。

この例を試すには、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 などのデザイン ホスト内の Web サーバー コントロールのデザイン時のサポートを提供するために継承および拡張できる基本コントロール デザイナー クラスを提供します。

デザイン時レンダリングを操作するためのオブジェクト モデルは、以前のバージョンよりも改善され、簡略化されたオブジェクト モデルへのアクセスを提供するために、次の新しい基本クラスが追加されました。

• ControlDesignerは新しいものではありませんが、大幅に改善されました。

• ContainerControlDesigner.

• CompositeControlDesigner.

自動書式

カスタム Web サーバー コントロールに複雑なスタイル変更を適用するページ開発者のプロセスを簡略化できる、さまざまな自動および定義済みの形式を作成できます。 たとえば、 TableDesigner クラスから ControlDesigner 派生したコントロールには、選択できる多くの自動形式が用意されています。 カスタム コントロールに自動書式設定を実装して提供するには、次の機能を使用します。

• AutoFormats プロパティ。

• OnAutoFormatApplied メソッド。

• DesignerAutoFormat クラスです。

• DesignerAutoFormatStyle クラスです。

アクション リスト (スマート タグ)

アクション リストは、コントロールを使用するページ開発者が Visual Studio 2005 などのデザイン時ユーザー インターフェイス (UI) で実行できる、重要または広く使用されているタスクのメニューです。 たとえば、コントロールのデザイン時ビューでは、使用可能なタスクのメニューを提供できます。 これには、コントロールを自動的に書式設定するタスクが含まれます。 アクション リストの詳細については、次の機能から始めます。

• ActionLists プロパティ。

• DesignerActionList クラスです。

• GetSortedActionItems メソッド。

• DesignerActionListCollection クラスです。

• DesignerActionMethodItem クラスです。

• DesignerActionPropertyItem クラスです。

コントロール デザイナー領域

領域は、Web サーバー コントロールのデザイン時ビューの編集可能な領域です。 この機能は、デザイン時に、テンプレート コンテンツ、内部コントロール、およびプロパティの WYSIWYG のような編集を提供します。 コントロール デザイナーで領域にコントロールを作成したり、ツールボックスを使用して領域にコントロールをドラッグ アンド ドロップしたりできます。 リージョンは、次の機能で管理されます。

• OnClick メソッド。

• DesignerRegion クラスです。

• EditableDesignerRegion クラスです。

• GetEditableDesignerRegionContent メソッド。

• SetEditableDesignerRegionContent メソッド。

テンプレート

コントロールなどのテンプレート化されたコントロールのデザイン時編集用の UI を作成するためのモデルが、以前の GridView バージョンから大幅に改善されました。 コントロールのさまざまな部分のテンプレートを含む複雑なカスタム コントロールを作成できます。カスタム コントロール デザイナーは、次の機能を使用してテンプレートを変更するページ開発者を支援できます。

• TemplateGroups プロパティ。

• InTemplateMode プロパティ。

• TemplateGroup クラスです。

Design-Time レンダリング

ControlDesignerクラスには、Web サーバー コントロールのデザイン時レンダリングをサポートする次のメソッドがあります。 これらのメソッドのほとんどは、以前のバージョンと同じです。

• GetDesignTimeHtml メソッド。

• GetEmptyDesignTimeHtml メソッド。

• GetErrorDesignTimeHtml メソッド。

• UpdateDesignTimeHtml メソッド。

• CreatePlaceHolderDesignTimeHtml メソッド。

コンストラクター

プロパティ

メソッド

明示的なインターフェイスの実装

適用対象

こちらもご覧ください

• TemplateGroup
• DesignerAutoFormat
• DesignerActionList
• DesignerRegion
• ContainerControlDesigner
• CompositeControlDesigner
• ASP.NET コントロール デザイナーの概要
• デザイン時アーキテクチャ
• アクション リストとサービスを含むサンプル コントロール デザイナー