DesignerAutoFormatCollection 類別

定義

表示控制項設計工具內的 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
繼承
DesignerAutoFormatCollection
實作

範例

下列程式碼範例示範如何在自訂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:

  • 要將單一格式加入至集合的方法。AddThe 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.

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

  • Count屬性, 用來判斷集合中的格式數目。The 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 類別的新執行個體。Initializes a new instance of the DesignerAutoFormatCollection class.

屬性

Count

取得集合中 DesignerAutoFormat 物件的數目。Gets the number of DesignerAutoFormat objects in the collection.

Item[Int32]

取得或設定位於集合中指定索引上的 DesignerAutoFormat 物件。Gets or sets a DesignerAutoFormat object at the specified index in the collection.

PreviewSize

取得控制項在執行階段顯示時的最大外部維度數目。Gets the maximum outer dimensions of the control as it will appear at run time.

SyncRoot

取得可用來同步處理對 DesignerAutoFormatCollection 物件之存取的物件。Gets an object that can be used to synchronize access to the DesignerAutoFormatCollection object.

方法

Add(DesignerAutoFormat)

將指定的 DesignerAutoFormat 物件加入至集合的尾端。Adds the specified DesignerAutoFormat object to the end of the collection.

Clear()

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

Contains(DesignerAutoFormat)

判斷集合內是否包含指定的格式。Determines whether the specified format is contained within the collection.

Equals(Object)

判斷指定的物件是否等於目前的物件。Determines whether the specified object is equal to the current object.

(繼承來源 Object)
GetHashCode()

作為預設雜湊函數。Serves as the default hash function.

(繼承來源 Object)
GetType()

取得目前執行個體的 TypeGets the Type of the current instance.

(繼承來源 Object)
IndexOf(DesignerAutoFormat)

傳回指定的 DesignerAutoFormat 物件在集合中的索引。Returns the index of the specified DesignerAutoFormat object within the collection.

Insert(Int32, DesignerAutoFormat)

DesignerAutoFormat 插入位於指定索引的集合。Inserts a DesignerAutoFormat object into the collection at the specified index.

MemberwiseClone()

建立目前 Object 的淺層複製。Creates a shallow copy of the current Object.

(繼承來源 Object)
Remove(DesignerAutoFormat)

從集合中移除指定的 DesignerAutoFormat 物件。Removes the specified DesignerAutoFormat object from the collection.

RemoveAt(Int32)

移除位於集合中指定索引上的 DesignerAutoFormat 物件。Removes the DesignerAutoFormat object at the specified index within the collection.

ToString()

傳回代表目前物件的字串。Returns a string that represents the current object.

(繼承來源 Object)

明確介面實作

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

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

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()

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)

DesignerAutoFormatCollection 物件轉換為 IList 介面時,將項目加入集合。Adds an item to the collection when the DesignerAutoFormatCollection object is cast to an IList interface.

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)

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)

DesignerAutoFormatCollection 物件轉換為 IList 介面時,將項目插入集合的指定索引處。Inserts an item into the collection at the specified index when the DesignerAutoFormatCollection object is cast to an IList interface.

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

如需這個方法的描述,請參閱 IsReadOnlyFor a description of this method, see IsReadOnly.

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)

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)

DesignerAutoFormatCollection 物件轉換為 IList 介面時,移除指定索引處的項目。Removes the item at the specified index when the DesignerAutoFormatCollection object is cast to an IList interface.

擴充方法

Cast<TResult>(IEnumerable)

IEnumerable 的項目轉換成指定的型別。Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

根據指定的型別來篩選 IEnumerable 的項目。Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

啟用查詢的平行化作業。Enables parallelization of a query.

AsQueryable(IEnumerable)

IEnumerable 轉換成 IQueryableConverts an IEnumerable to an IQueryable.

適用於

另請參閱