DesignerAutoFormatCollection 類別

定義

代表控制項設計工具中的 DesignerAutoFormat 物件集合。 此類別無法獲得繼承。

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 作 屬性。 衍生控制項設計工具會新增衍生自 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

備註

類別 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

適用於

另請參閱