DesignerAutoFormat 类

定义

为创建设计时可应用于自定义 Web 服务器控件的格式提供抽象基类。Provides the abstract base class for creating formats that can be applied to a custom Web server control at design time.

public ref class DesignerAutoFormat abstract
public abstract class DesignerAutoFormat
type DesignerAutoFormat = class
Public MustInherit Class DesignerAutoFormat
继承
DesignerAutoFormat

示例

下面的代码示例演示如何在自定义控件设计器中实现自动格式设置。The following code example demonstrates how to implement automatic formatting in a custom control designer. 派生的控件设计器通过AutoFormats添加派生DesignerAutoFormat自类的自定义自动格式的三个实例来实现属性。The derived control designer implements the AutoFormats property by adding three instances of a custom automatic format that are derived from the DesignerAutoFormat class.

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 设计器工具 (如) Visual Studio 2005Visual Studio 2005中显示格式化的自定义 Web 服务器控件。DesignerAutoFormat provides a base class that can be inherited from and extended to display a formatted custom Web server control at design time in a visual designer tool such as Visual Studio 2005Visual Studio 2005.

控件开发人员提供自动格式设置, 以帮助使用控件的开发人员选择首选的显示。A control developer provides automatic formatting in order to help developers who use the control to select a preferred display. DesignerAutoFormat定义对象与自定义控件设计器一起使用, 以便在设计时为自定义控件提供自动格式设置。A custom DesignerAutoFormat object works with a custom control designer to provide automatic formatting at design time for a custom control. 例如, Calendar控件提供了可在设计时应用于开发人员的各种格式。For example, the Calendar control provides a variety of formats that can be applied by a developer at design time.

若要实现自定义控件的自动格式设置, 请执行以下操作:To implement automatic formatting for a custom control:

  1. 创建自定义控件。Create the custom control.

  2. ControlDesigner类派生一个设计器类, 或从适用于控件的另一个设计器类派生, TextControlDesigner例如。Derive a designer class from the ControlDesigner class or another designer class that is appropriate for your control, such as the TextControlDesigner.

  3. DesignerAutoFormat 通过Apply重写方法, 从类派生格式类, 从而设置自定义控件的格式。Derive a format class from the DesignerAutoFormat class that formats your custom control by overriding the Apply method.

  4. 在设计器类中, 用AutoFormats您的设计器可以DesignerAutoFormatCollection应用的每个命名格式填充一个对象的属性, 该属性是一个对象。In your designer class, populate the AutoFormats property, which is a DesignerAutoFormatCollection object, with one instance of your format class for each named format that your designer can apply.

DesignerAutoFormat类提供以下成员以支持在设计时自动设置格式:The DesignerAutoFormat class provides the following members to support automatic formatting at design time:

  • Apply方法, 它将命名格式应用于指定的控件。The Apply method, which applies the named format to the specified control.

  • 方法, 它提供控件的副本, 以便在可视化设计器 (如) Visual Studio 2005Visual Studio 2005"自动套用格式" 对话框中预览。 GetPreviewControlThe GetPreviewControl method, which provides a copy of the control for previewing in an AutoFormat dialog box of a visual designer such as Visual Studio 2005Visual Studio 2005.

  • Name属性, 提供要在可视化设计器的格式列表中显示的文本。The Name property, which provides the text to display in a list of formats in a visual designer.

实施者说明

DesignerAutoFormat类继承时, 必须Apply(Control)重写方法以预览格式化的控件并将所选格式应用于控件。When you inherit from the DesignerAutoFormat class, you must override the Apply(Control) method to preview a formatted control and to apply the selected format to your control.

构造函数

DesignerAutoFormat(String)

初始化 DesignerAutoFormat 类的新实例。Initializes a new instance of the DesignerAutoFormat class.

属性

Name

获取 DesignerAutoFormat 对象的名称。Gets the name of a DesignerAutoFormat object.

Style

获取一个 DesignerAutoFormatStyle 对象,DesignerAutoFormat 对象将使用该对象呈现关联控件的设计时预览。Gets a DesignerAutoFormatStyle object that is used by the DesignerAutoFormat object to render a design-time preview of the associated control.

方法

Apply(Control)

对指定控件应用关联的格式设置。Applies the associated formatting to the specified control.

Equals(Object)

确定指定对象是否等于当前对象。Determines whether the specified object is equal to the current object.

(继承自 Object)
GetHashCode()

用作默认哈希函数。Serves as the default hash function.

(继承自 Object)
GetPreviewControl(Control)

返回关联控件的副本,以便在将格式应用于该控件之前提供预览。Returns a copy of the associated control in order to provide a preview before applying the format to the control.

GetType()

获取当前实例的 TypeGets the Type of the current instance.

(继承自 Object)
MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(继承自 Object)
ToString()

返回表示当前 DesignerAutoFormat 对象的字符串。Returns a string that represents the current DesignerAutoFormat object.

适用于

另请参阅