DesignerAutoFormatCollection 类

定义

命名空间:

System.Web.UI.Design

程序集:

System.Design.dll

表示控件设计器中 DesignerAutoFormat 对象的集合。 此类不能被继承。

C#

public sealed class DesignerAutoFormatCollection : System.Collections.IList

继承

Object

DesignerAutoFormatCollection

实现

ICollection IEnumerable IList

示例

下面的代码示例演示如何在自定义控件设计器中实现 AutoFormats 属性。 派生控件设计器通过添加派生自 DesignerAutoFormat 类的自定义自动格式的三个实例来实现 AutoFormats 属性。

C#

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;
                    }
                }
            }
        }
    }
}

注解

类 ControlDesigner 和任何派生类将 AutoFormats 属性 DesignerAutoFormatCollection 定义为 对象。 控件开发人员可以在派生的控件设计器中重写 AutoFormats 属性，添加自定义自动格式设置样式，并将受支持的格式集合返回到可视化设计器。

集合随着对象的添加而动态增加。 此集合中的索引从零开始。 Count使用 属性可确定集合中的自动样式格式数。

此外，使用 DesignerAutoFormatCollection 方法和属性提供以下功能：

• 向 Add 集合添加单个格式的方法。

• 用于 Insert 在集合中的特定索引处添加格式的方法。

• 用于 Remove 删除格式的方法。

• 用于 RemoveAt 删除特定索引处的格式的方法。

• 用于 Contains 确定集合中是否已存在特定格式的方法。

• 用于 IndexOf 检索集合中某个格式的索引的方法。

• 使用 Item[] 数组表示法获取或设置特定索引处的格式的属性。

• 从 Clear 集合中删除所有格式的方法。

• 用于 Count 确定集合中格式数的属性。

• 用于 IndexOf 获取集合中格式位置的方法。

构造函数

DesignerAutoFormatCollection()

初始化 DesignerAutoFormatCollection 类的新实例。

属性

Count	获取集合中 DesignerAutoFormat 对象的数量。
Item[Int32]	获取或设置集合中指定索引处的 DesignerAutoFormat 对象。
PreviewSize	获取控件将在运行时显示的最大外部尺寸。
SyncRoot	获取一个对象，该对象可用于同步对 DesignerAutoFormatCollection 对象的访问。

方法

Add(DesignerAutoFormat)	将指定的 DesignerAutoFormat 对象添加到集合末尾。
Clear()	从集合中移除所有格式。
Contains(DesignerAutoFormat)	确定指定格式是否包含在集合中。
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
IndexOf(DesignerAutoFormat)	返回指定的 DesignerAutoFormat 对象在集合中的索引。
Insert(Int32, DesignerAutoFormat)	将 DesignerAutoFormat 对象插入到集合中的指定索引处。
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
Remove(DesignerAutoFormat)	从集合中移除指定的 DesignerAutoFormat 对象。
RemoveAt(Int32)	移除集合中指定索引处的 DesignerAutoFormat 对象。
ToString()	返回表示当前对象的字符串。 (继承自 Object)

显式接口实现

ICollection.CopyTo(Array, Int32)	当 Array 对象被强制转换为 Array 接口时，从特定 DesignerAutoFormatCollection 索引开始将集合的元素复制到一个 ICollection 对象。
ICollection.Count	获取当 DesignerAutoFormatCollection 对象强制转换为 ICollection 接口时包含在集合中的元素的数目。
ICollection.IsSynchronized	获取一个值，该值指示当 DesignerAutoFormatCollection 对象强制转换为 ICollection 接口时对集合的访问是否同步（线程安全）。
IEnumerable.GetEnumerator()	返回一个 IEnumerator 接口，该接口在 DesignerAutoFormatCollection 对象被强制转换为 IEnumerable 接口时循环访问该集合。
IList.Add(Object)	当 DesignerAutoFormatCollection 对象被强制转换为 IList 接口时向该集合添加一个项。
IList.Contains(Object)	当 DesignerAutoFormatCollection 对象被强制转换为 IList 接口时，确定该集合是否包含某个特定的值。
IList.IndexOf(Object)	当 DesignerAutoFormatCollection 对象被强制转换为 IList 接口时，确定该集合中特定项的索引。
IList.Insert(Int32, Object)	当 DesignerAutoFormatCollection 对象被强制转换为 IList 接口时，在该集合中的指定索引处插入一个项。
IList.IsFixedSize	获取一个值，该值指示当 DesignerAutoFormatCollection 对象强制转换为 IList 接口时集合是否具有固定大小。
IList.IsReadOnly	有关此方法的说明，请参阅 IsReadOnly。
IList.Item[Int32]	当 DesignerAutoFormatCollection 对象被强制转换为 IList 接口时，获取指定索引处的元素。
IList.Remove(Object)	当 DesignerAutoFormatCollection 对象被强制转换为 IList 接口时，移除特定对象在集合中的第一个匹配项。
IList.RemoveAt(Int32)	当 DesignerAutoFormatCollection 对象被强制转换为 IList 接口时，移除指定索引处的项。

扩展方法

Cast<TResult>(IEnumerable)	将 IEnumerable 的元素强制转换为指定的类型。
OfType<TResult>(IEnumerable)	根据指定类型筛选 IEnumerable 的元素。
AsParallel(IEnumerable)	启用查询的并行化。
AsQueryable(IEnumerable)	将 IEnumerable 转换为 IQueryable。

适用于

另请参阅

• DesignerAutoFormat
• ControlDesigner
• AutoFormats
• DesignerAutoFormatStyle
• ASP.NET 控件设计器概述