DesignerAutoFormat クラス

定義

名前空間:

System.Web.UI.Design

アセンブリ:

System.Design.dll

デザイン時にカスタム Web サーバー コントロールに適用できる書式を作成するための抽象基本クラスを提供します。

public ref class DesignerAutoFormat abstract

public abstract class DesignerAutoFormat

type DesignerAutoFormat = class

Public MustInherit Class DesignerAutoFormat

継承

Object

DesignerAutoFormat

例

次のコード例では、カスタム コントロール デザイナーで自動書式設定を実装する方法を示します。 派生コントロール デザイナーは、 クラスから派生したカスタム自動形式の 3 つのインスタンスを追加することによって、 プロパティをDesignerAutoFormat実装AutoFormatsします。

using System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Web.UI;
using System.Web.UI.Design;
using System.Web.UI.Design.WebControls;
using System.Web.UI.WebControls;

namespace CustomControls.Design.CS
{
    // A custom Label control whose contents can be indented
    [Designer(typeof(IndentLabelDesigner)), 
        ToolboxData("<{0}:IndentLabel Runat=\"server\"></{0}:IndentLabel>")]
    public class IndentLabel : Label
    {
        private int _indent = 0;

        // Property to indent all text within the label
        [Category("Appearance"), DefaultValue(0), 
            PersistenceMode(PersistenceMode.Attribute)]
        public int Indent
        {
            get { return _indent; }
            set
            {
                _indent = value;
                // Get the number of pixels to indent
                int ind = value * 8;

                //  Add the indent style to the control
                if (ind > 0)
                    this.Style.Add(HtmlTextWriterStyle.MarginLeft, ind.ToString() + "px");
                else
                    this.Style.Remove(HtmlTextWriterStyle.MarginLeft);
            }
        }
    }

    // A design-time ControlDesigner for the IndentLabel control
    [SupportsPreviewControl(true)]
    public class IndentLabelDesigner : LabelDesigner
    {
        private DesignerAutoFormatCollection _autoFormats = null;

        // The collection of AutoFormat objects for the IndentLabel object
        public override DesignerAutoFormatCollection AutoFormats
        {
            get
            {
                if (_autoFormats == null)
                {
                    // Create the collection
                    _autoFormats = new DesignerAutoFormatCollection();

                    // Create and add each AutoFormat object
                    _autoFormats.Add(new IndentLabelAutoFormat("MyClassic"));
                    _autoFormats.Add(new IndentLabelAutoFormat("MyBright"));
                    _autoFormats.Add(new IndentLabelAutoFormat("Default"));
                }
                return _autoFormats;
            }
        }

        // An AutoFormat object for the IndentLabel control
        private class IndentLabelAutoFormat : DesignerAutoFormat
        {
            public IndentLabelAutoFormat(string name) : base(name)
            { }

            // Applies styles based on the Name of the AutoFormat
            public override void Apply(Control inLabel)
            {
                if (inLabel is IndentLabel)
                {
                    IndentLabel ctl = (IndentLabel)inLabel;

                    // Apply formatting according to the Name
                    if (this.Name == "MyClassic")
                    {
                        // For MyClassic, apply style elements directly to the control
                        ctl.ForeColor = Color.Gray;
                        ctl.BackColor = Color.LightGray;
                        ctl.Font.Size = FontUnit.XSmall;
                        ctl.Font.Name = "Verdana,Geneva,Sans-Serif";
                    }
                    else if (this.Name == "MyBright")
                    {
                        // For MyBright, apply style elements to the Style property
                        this.Style.ForeColor = Color.Maroon;
                        this.Style.BackColor = Color.Yellow;
                        this.Style.Font.Size = FontUnit.Medium;

                        // Merge the AutoFormat style with the control's style
                        ctl.MergeStyle(this.Style);
                    }
                    else
                    {
                        // For the Default format, apply style elements to the control
                        ctl.ForeColor = Color.Black;
                        ctl.BackColor = Color.Empty;
                        ctl.Font.Size = FontUnit.XSmall;
                    }
                }
            }
        }
    }
}

Imports System.Drawing
Imports System.Collections
Imports System.ComponentModel
Imports System.Web.UI
Imports System.Web.UI.Design
Imports System.Web.UI.Design.WebControls
Imports System.Web.UI.WebControls

Namespace CustomControls.Design

    ' A custom Label control whose contents can be indented
    <Designer(GetType(IndentLabelDesigner)), _
        ToolboxData("<{0}:IndentLabel Runat=""server""></{0}:IndentLabel>")> _
    Public Class IndentLabel
        Inherits System.Web.UI.WebControls.Label

        Dim _indent As Integer = 0

        <Category("Appearance"), DefaultValue(0), _
            PersistenceMode(PersistenceMode.Attribute)> _
        Property Indent() As Integer
            Get
                Return _indent
            End Get
            Set(ByVal Value As Integer)
                _indent = Value

                ' Get the number of pixels to indent
                Dim ind As Integer = _indent * 8

                ' Add the indent style to the control
                If ind > 0 Then
                    Me.Style.Add(HtmlTextWriterStyle.MarginLeft, ind.ToString() & "px")
                Else
                    Me.Style.Remove(HtmlTextWriterStyle.MarginLeft)
                End If
            End Set
        End Property

    End Class

    ' A design-time ControlDesigner for the IndentLabel control
    Public Class IndentLabelDesigner
        Inherits LabelDesigner

        Private _autoFormats As DesignerAutoFormatCollection = Nothing
        ' The collection of AutoFormat objects for the IndentLabel object
        Public Overrides ReadOnly Property AutoFormats() As DesignerAutoFormatCollection
            Get
                If _autoFormats Is Nothing Then
                    ' Create the collection
                    _autoFormats = New DesignerAutoFormatCollection()

                    ' Create and add each AutoFormat object
                    _autoFormats.Add(New IndentLabelAutoFormat("MyClassic"))
                    _autoFormats.Add(New IndentLabelAutoFormat("MyBright"))
                    _autoFormats.Add(New IndentLabelAutoFormat("Default"))
                End If

                Return _autoFormats
            End Get
        End Property

        ' An AutoFormat object for the IndentLabel control
        Public Class IndentLabelAutoFormat
            Inherits DesignerAutoFormat

            Public Sub New(ByVal name As String)
                MyBase.New(name)
            End Sub

            ' Applies styles based on the Name of the AutoFormat
            Public Overrides Sub Apply(ByVal inLabel As Control)
                If TypeOf inLabel Is IndentLabel Then
                    Dim ctl As IndentLabel = CType(inLabel, IndentLabel)

                    ' Apply formatting according to the Name
                    If Me.Name.Equals("MyClassic") Then
                        ' For MyClassic, apply style elements directly to the control
                        ctl.ForeColor = Color.Gray
                        ctl.BackColor = Color.LightGray
                        ctl.Font.Size = FontUnit.XSmall
                        ctl.Font.Name = "Verdana,Geneva,Sans-Serif"
                    ElseIf Me.Name.Equals("MyBright") Then
                        ' For MyBright, apply style elements to the Style object
                        Me.Style.ForeColor = Color.Maroon
                        Me.Style.BackColor = Color.Yellow
                        Me.Style.Font.Size = FontUnit.Medium

                        ' Merge the AutoFormat style with the control's style
                        ctl.MergeStyle(Me.Style)
                    Else
                        ' For the Default format, apply style elements to the control
                        ctl.ForeColor = Color.Black
                        ctl.BackColor = Color.Empty
                        ctl.Font.Size = FontUnit.XSmall
                    End If
                End If
            End Sub
        End Class
    End Class

End Namespace

注釈

DesignerAutoFormat は、Visual Studio 2005 などのビジュアル デザイナー ツールでデザイン時に書式設定されたカスタム Web サーバー コントロールを表示するために継承および拡張できる基本クラスを提供します。

コントロール開発者は、コントロールを使用して優先するディスプレイを選択する開発者を支援するために、自動書式設定を提供します。 カスタム DesignerAutoFormat オブジェクトは、カスタム コントロール デザイナーと連携して、カスタム コントロールのデザイン時に自動書式設定を提供します。 たとえば、コントロールには Calendar 、開発者がデザイン時に適用できるさまざまな形式が用意されています。

カスタム コントロールの自動書式設定を実装するには:

1. カスタム コントロールを作成します。

2. クラスまたはコントロールに適した別の ControlDesigner デザイナー クラス (など) からデザイナー クラスを TextControlDesigner派生させます。

3. メソッドをオーバーライドしてカスタム コントロールの DesignerAutoFormat 書式を設定するクラスから format クラスを Apply 派生させます。

4. デザイナー クラスで、 プロパティ ( AutoFormats オブジェクト) に、デザイナーが DesignerAutoFormatCollection 適用できる名前付き書式ごとに書式クラスのインスタンスを 1 つ設定します。

クラスは DesignerAutoFormat 、デザイン時の自動書式設定をサポートするために、次のメンバーを提供します。

• 指定 Apply したコントロールに名前付き書式を適用する メソッド。

• GetPreviewControl Visual Studio 2005 などのビジュアル デザイナーの [オートフォーマット] ダイアログ ボックスでプレビューするためのコントロールのコピーを提供する メソッド。

• プロパティ。 Name ビジュアル デザイナーで書式の一覧に表示するテキストを提供します。

注意 (実装者)

クラスから DesignerAutoFormat 継承する場合は、 メソッドを Apply(Control) オーバーライドして書式設定されたコントロールをプレビューし、選択した書式をコントロールに適用する必要があります。

コンストラクター

DesignerAutoFormat(String)

DesignerAutoFormat クラスの新しいインスタンスを初期化します。

プロパティ

Name	DesignerAutoFormat オブジェクトの名前を取得します。
Style	関連付けられたコントロールのデザイン時プレビューを表示するために DesignerAutoFormatStyle オブジェクトが使用する DesignerAutoFormat オブジェクトを取得します。

メソッド

Apply(Control)	関連付けられている書式を指定したコントロールに適用します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetPreviewControl(Control)	書式をコントロールに適用する前にプレビューできるように、関連付けられているコントロールのコピーを返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在の DesignerAutoFormat オブジェクトを表す文字列を返します。

こちらもご覧ください

• DesignerAutoFormatCollection
• DesignerAutoFormatStyle
• AutoFormats
• ControlDesigner
• ASP.NET コントロール デザイナーの概要