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クラスから派生したカスタム自動形式の3つのインスタンスを追加することによって、プロパティを実装します。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

注釈

クラスControlDesignerとすべての派生クラスは、 AutoFormatsプロパティをDesignerAutoFormatCollectionオブジェクトとして定義します。The 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. このコレクションのインデックスは0から始まります。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:

  • コレクションに1つの形式を追加するメソッド。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.

  • 書式を削除するメソッド。RemoveThe 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()

現在のインスタンスの Type を取得します。Gets 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

このメソッドの説明については、「IsReadOnly」を参照してください。For 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)

IEnumerableIQueryable に変換します。Converts an IEnumerable to an IQueryable.

適用対象

こちらもご覧ください