DesignerAutoFormatCollection DesignerAutoFormatCollection DesignerAutoFormatCollection DesignerAutoFormatCollection Class

定义

表示控件设计器内的 DesignerAutoFormat 对象的集合。Represents a collection of DesignerAutoFormat objects within a control designer. 此类不能被继承。This class cannot be inherited.

public ref class DesignerAutoFormatCollection sealed : System::Collections::IList
public sealed class DesignerAutoFormatCollection : System.Collections.IList
type DesignerAutoFormatCollection = class
    interface IList
    interface ICollection
    interface IEnumerable
Public NotInheritable Class DesignerAutoFormatCollection
Implements IList
继承
DesignerAutoFormatCollectionDesignerAutoFormatCollectionDesignerAutoFormatCollectionDesignerAutoFormatCollection
实现

示例

下面的代码示例演示如何在自定义AutoFormats控件设计器中实现属性。The following code example demonstrates how to implement the AutoFormats property 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

注解

类和任何派生类将AutoFormats属性定义为DesignerAutoFormatCollection对象。 ControlDesignerThe ControlDesigner class and any derived class defines the AutoFormats property as a DesignerAutoFormatCollection object. 控件开发人员可以覆盖AutoFormats派生控件设计器中的属性, 添加自定义自动格式设置样式, 并将支持的格式的集合返回到可视化设计器。Control developers can override the AutoFormats property in a derived control designer, add custom automatic formatting styles, and return the collection of supported formats to the visual designer.

添加对象时, 集合会动态增加。The collection dynamically increases as objects are added. 此集合中的索引从零开始。Indexes in this collection are zero-based. Count使用属性可确定集合中有多少自动样式格式。Use the Count property to determine how many automatic style formats are in the collection.

此外, 使用DesignerAutoFormatCollection方法和属性提供以下功能:Additionally, use the DesignerAutoFormatCollection methods and properties to provide the following functionality:

  • Add集合添加单个格式的方法。The Add method to add a single format to the collection.

  • 用于在集合中的特定索引处添加格式的方法。InsertThe Insert method to add a format at a particular index within the collection.

  • 用于Remove删除格式的方法。The Remove method to remove a format.

  • 用于移除特定索引处的格式的方法。RemoveAtThe RemoveAt method to remove the format at a particular index.

  • 用于确定特定格式是否已存在于集合中的方法。ContainsThe Contains method to determine whether a particular format is already in the collection.

  • 用于检索集合中的格式索引的方法。IndexOfThe IndexOf method to retrieve the index of a format within the collection.

  • 用于获取或设置特定索引处的格式的属性,使用数组表示法。Item[Int32]The Item[Int32] property to get or set the format at a particular index, using array notation.

  • 要从集合中移除所有格式的方法。ClearThe Clear method to remove all formats from the collection.

  • 用于确定集合中格式数目的属性。CountThe Count property to determine the number of formats in the collection.

  • 用于获取格式在集合中的位置的方法。IndexOfThe IndexOf method to get the position of a format within the collection.

构造函数

DesignerAutoFormatCollection() DesignerAutoFormatCollection() DesignerAutoFormatCollection() DesignerAutoFormatCollection()

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

属性

Count Count Count Count

获取集合中 DesignerAutoFormat 对象的数量。Gets the number of DesignerAutoFormat objects in the collection.

Item[Int32] Item[Int32] Item[Int32] Item[Int32]

获取或设置集合中指定索引处的 DesignerAutoFormat 对象。Gets or sets a DesignerAutoFormat object at the specified index in the collection.

PreviewSize PreviewSize PreviewSize PreviewSize

获取控件将在运行时显示的最大外部尺寸。Gets the maximum outer dimensions of the control as it will appear at run time.

SyncRoot SyncRoot SyncRoot SyncRoot

获取一个对象,该对象可用于同步对 DesignerAutoFormatCollection 对象的访问。Gets an object that can be used to synchronize access to the DesignerAutoFormatCollection object.

方法

Add(DesignerAutoFormat) Add(DesignerAutoFormat) Add(DesignerAutoFormat) Add(DesignerAutoFormat)

将指定的 DesignerAutoFormat 对象添加到集合末尾。Adds the specified DesignerAutoFormat object to the end of the collection.

Clear() Clear() Clear() Clear()

从集合中移除所有格式。Removes all formats from the collection.

Contains(DesignerAutoFormat) Contains(DesignerAutoFormat) Contains(DesignerAutoFormat) Contains(DesignerAutoFormat)

确定指定格式是否包含在集合中。Determines whether the specified format is contained within the collection.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

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

(Inherited from Object)
GetType() GetType() GetType() GetType()

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

(Inherited from Object)
IndexOf(DesignerAutoFormat) IndexOf(DesignerAutoFormat) IndexOf(DesignerAutoFormat) IndexOf(DesignerAutoFormat)

返回指定的 DesignerAutoFormat 对象在集合中的索引。Returns the index of the specified DesignerAutoFormat object within the collection.

Insert(Int32, DesignerAutoFormat) Insert(Int32, DesignerAutoFormat) Insert(Int32, DesignerAutoFormat) Insert(Int32, DesignerAutoFormat)

DesignerAutoFormat 对象插入到集合中的指定索引处。Inserts a DesignerAutoFormat object into the collection at the specified index.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
Remove(DesignerAutoFormat) Remove(DesignerAutoFormat) Remove(DesignerAutoFormat) Remove(DesignerAutoFormat)

从集合中移除指定的 DesignerAutoFormat 对象。Removes the specified DesignerAutoFormat object from the collection.

RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32)

移除集合中指定索引处的 DesignerAutoFormat 对象。Removes the DesignerAutoFormat object at the specified index within the collection.

ToString() ToString() ToString() ToString()

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

(Inherited from Object)

显式界面实现

ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32)

Array 对象被强制转换为 Array 接口时,从特定 DesignerAutoFormatCollection 索引开始将集合的元素复制到一个 ICollection 对象。Copies the elements of the collection to an Array object, starting at a particular Array index when the DesignerAutoFormatCollection object is cast to an ICollection interface.

ICollection.Count ICollection.Count ICollection.Count ICollection.Count

获取当 DesignerAutoFormatCollection 对象强制转换为 ICollection 接口时包含在集合中的元素的数目。Gets the number of elements that are contained in the collection when the DesignerAutoFormatCollection object is cast to an ICollection interface.

ICollection.IsSynchronized ICollection.IsSynchronized ICollection.IsSynchronized ICollection.IsSynchronized

获取一个值,该值指示当 DesignerAutoFormatCollection 对象强制转换为 ICollection 接口时对集合的访问是否同步(线程安全)。Gets a value that indicates whether access to the collection is synchronized (thread safe) when the DesignerAutoFormatCollection object is cast to an ICollection interface.

IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator()

返回一个 IEnumerator 接口,该接口在 DesignerAutoFormatCollection 对象被强制转换为 IEnumerable 接口时循环访问该集合。Returns an IEnumerator interface that iterates through the collection when the DesignerAutoFormatCollection object is cast to an IEnumerable interface.

IList.Add(Object) IList.Add(Object) IList.Add(Object) IList.Add(Object)

DesignerAutoFormatCollection 对象被强制转换为 IList 接口时向该集合添加一个项。Adds an item to the collection when the DesignerAutoFormatCollection object is cast to an IList interface.

IList.Contains(Object) IList.Contains(Object) IList.Contains(Object) IList.Contains(Object)

DesignerAutoFormatCollection 对象被强制转换为 IList 接口时,确定该集合是否包含某个特定的值。Determines whether the collection contains a specific value when the DesignerAutoFormatCollection object is cast to an IList interface.

IList.IndexOf(Object) IList.IndexOf(Object) IList.IndexOf(Object) IList.IndexOf(Object)

DesignerAutoFormatCollection 对象被强制转换为 IList 接口时,确定该集合中特定项的索引。Determines the index of a specific item in the collection when the DesignerAutoFormatCollection object is cast to an IList interface.

IList.Insert(Int32, Object) IList.Insert(Int32, Object) IList.Insert(Int32, Object) IList.Insert(Int32, Object)

DesignerAutoFormatCollection 对象被强制转换为 IList 接口时,在该集合中的指定索引处插入一个项。Inserts an item into the collection at the specified index when the DesignerAutoFormatCollection object is cast to an IList interface.

IList.IsFixedSize IList.IsFixedSize IList.IsFixedSize IList.IsFixedSize

获取一个值,该值指示当 DesignerAutoFormatCollection 对象强制转换为 IList 接口时集合是否具有固定大小。Gets a value that indicates whether the collection has a fixed size when the DesignerAutoFormatCollection object is cast to an IList interface.

IList.IsReadOnly IList.IsReadOnly IList.IsReadOnly IList.IsReadOnly

有关此方法的说明,请参见 IsReadOnlyFor a description of this method, see IsReadOnly.

IList.Item[Int32] IList.Item[Int32] IList.Item[Int32] IList.Item[Int32]

DesignerAutoFormatCollection 对象被强制转换为 IList 接口时,获取指定索引处的元素。Gets the element at the specified index when the DesignerAutoFormatCollection object is cast to an IList interface.

IList.Remove(Object) IList.Remove(Object) IList.Remove(Object) IList.Remove(Object)

DesignerAutoFormatCollection 对象被强制转换为 IList 接口时,移除特定对象在集合中的第一个匹配项。Removes the first occurrence of a specific object from the collection when the DesignerAutoFormatCollection object is cast to an IList interface.

IList.RemoveAt(Int32) IList.RemoveAt(Int32) IList.RemoveAt(Int32) IList.RemoveAt(Int32)

DesignerAutoFormatCollection 对象被强制转换为 IList 接口时,移除指定索引处的项。Removes the item at the specified index when the DesignerAutoFormatCollection object is cast to an IList interface.

扩展方法

Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable)

IEnumerable 的元素强制转换为指定的类型。Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable)

根据指定类型筛选 IEnumerable 的元素。Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable)

启用查询的并行化。Enables parallelization of a query.

AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable)

IEnumerable 转换为 IQueryableConverts an IEnumerable to an IQueryable.

适用于

另请参阅