DesignerAutoFormatCollection Clase

Definición

Espacio de nombres:

System.Web.UI.Design

Ensamblado:

System.Design.dll

Representa una colección de objetos DesignerAutoFormat dentro de un diseñador de controles. Esta clase no puede heredarse.

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

Herencia

Object

DesignerAutoFormatCollection

Implementaciones

ICollection IEnumerable IList

Ejemplos

En el ejemplo de código siguiente se muestra cómo implementar la AutoFormats propiedad en un diseñador de controles personalizado. El diseñador de controles derivado implementa la AutoFormats propiedad agregando tres instancias de un formato automático personalizado derivado de la DesignerAutoFormat clase .

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

Comentarios

La ControlDesigner clase y cualquier clase derivada definen la AutoFormats propiedad como un DesignerAutoFormatCollection objeto . Los desarrolladores de controles pueden invalidar la AutoFormats propiedad en un diseñador de controles derivados, agregar estilos de formato automático personalizados y devolver la colección de formatos admitidos al diseñador visual.

La colección aumenta dinámicamente a medida que se agregan objetos. Los índices de esta colección se basan en cero. Use la Count propiedad para determinar cuántos formatos de estilo automático hay en la colección.

Además, use los DesignerAutoFormatCollection métodos y propiedades para proporcionar la siguiente funcionalidad:

• Método Add para agregar un único formato a la colección.

• Método Insert para agregar un formato en un índice determinado dentro de la colección.

• Método Remove para quitar un formato.

• Método RemoveAt para quitar el formato en un índice determinado.

• Método Contains para determinar si un formato determinado ya está en la colección.

• Método IndexOf para recuperar el índice de un formato dentro de la colección.

• La Item[] propiedad que se va a obtener o establecer el formato en un índice determinado, mediante la notación de matriz.

• Método Clear para quitar todos los formatos de la colección.

• Propiedad Count para determinar el número de formatos de la colección.

• Método IndexOf para obtener la posición de un formato dentro de la colección.

Constructores

DesignerAutoFormatCollection()

Inicializa una nueva instancia de la clase DesignerAutoFormatCollection.

Propiedades

Count	Obtiene el número de objetos DesignerAutoFormat que hay en la colección.
Item[Int32]	Obtiene o establece un objeto DesignerAutoFormat en el índice especificado de la colección.
PreviewSize	Obtiene el número máximo de dimensiones externas como aparecerán en tiempo de ejecución.
SyncRoot	Obtiene un objeto que puede utilizarse para sincronizar el acceso al objeto DesignerAutoFormatCollection.

Métodos

Add(DesignerAutoFormat)	Agrega el objeto DesignerAutoFormat especificado al final de la colección.
Clear()	Quita todos los formatos de la colección.
Contains(DesignerAutoFormat)	Determina si el formato especificado está contenido en la colección.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IndexOf(DesignerAutoFormat)	Devuelve el índice del objeto DesignerAutoFormat especificado dentro de la colección.
Insert(Int32, DesignerAutoFormat)	Inserta un objeto DesignerAutoFormat en la colección, en el índice especificado.
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
Remove(DesignerAutoFormat)	Quita el objeto DesignerAutoFormat especificado de la colección.
RemoveAt(Int32)	Quita el objeto DesignerAutoFormat en el índice especificado de la colección.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Implementaciones de interfaz explícitas

ICollection.CopyTo(Array, Int32)	Copia los elementos de la colección en un objeto Array, empezando por un índice Array determinado cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz ICollection.
ICollection.Count	Obtiene el número de elementos que la colección contiene cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz ICollection.
ICollection.IsSynchronized	Obtiene un valor que indica si el acceso a la colección está sincronizado (es seguro para la ejecución de subprocesos) cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz ICollection.
IEnumerable.GetEnumerator()	Devuelve una interfaz IEnumerator que recorre en iteración la colección cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz IEnumerable.
IList.Add(Object)	Agrega un elemento a la colección cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz IList.
IList.Contains(Object)	Determina si la colección contiene un valor concreto cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz IList.
IList.IndexOf(Object)	Determina el índice de un elemento concreto de la colección cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz IList.
IList.Insert(Int32, Object)	Inserta un elemento en la colección en el índice especificado cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz IList.
IList.IsFixedSize	Obtiene un valor que indica si la colección tiene un tamaño fijo cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz IList.
IList.IsReadOnly	Para obtener una descripción de este método, consulte IsReadOnly.
IList.Item[Int32]	Obtiene el elemento del índice especificado cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz IList.
IList.Remove(Object)	Quita la primera aparición de un objeto concreto de la colección cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz IList.
IList.RemoveAt(Int32)	Quita el elemento del índice especificado cuando el objeto DesignerAutoFormatCollection se convierte en una interfaz IList.

Métodos de extensión

Cast<TResult>(IEnumerable)	Convierte los elementos de IEnumerable en el tipo especificado.
OfType<TResult>(IEnumerable)	Filtra los elementos de IEnumerable en función de un tipo especificado.
AsParallel(IEnumerable)	Habilita la paralelización de una consulta.
AsQueryable(IEnumerable)	Convierte una interfaz IEnumerable en IQueryable.

Consulte también

• DesignerAutoFormat
• ControlDesigner
• AutoFormats
• DesignerAutoFormatStyle
• Introducción a los diseñadores de controles de ASP.NET