DesignerAutoFormatCollection Classe

Definição

Namespace:

System.Web.UI.Design

Assembly:

System.Design.dll

Representa uma coleção de objetos DesignerAutoFormat em um designer de controle. Essa classe não pode ser herdada.

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

Herança

Object

DesignerAutoFormatCollection

Implementações

ICollection IEnumerable IList

Exemplos

O exemplo de código a seguir demonstra como implementar a AutoFormats propriedade em um designer de controle personalizado. O designer de controle derivado implementa a propriedade adicionando AutoFormats três instâncias de um formato automático personalizado derivado da DesignerAutoFormat classe.

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

Comentários

A ControlDesigner classe e qualquer classe derivada definem a AutoFormats propriedade como um DesignerAutoFormatCollection objeto. Os desenvolvedores de controle podem substituir a AutoFormats propriedade em um designer de controle derivado, adicionar estilos de formatação automática personalizados e retornar a coleção de formatos com suporte para o designer visual.

A coleção aumenta dinamicamente à medida que os objetos são adicionados. Os índices nesta coleção são baseados em zero. Use a Count propriedade para determinar quantos formatos de estilo automático estão na coleção.

Além disso, use os DesignerAutoFormatCollection métodos e as propriedades para fornecer a seguinte funcionalidade:

• O Add método para adicionar um único formato à coleção.

• O Insert método para adicionar um formato em um índice específico dentro da coleção.

• O Remove método para remover um formato.

• O RemoveAt método para remover o formato em um índice específico.

• O Contains método para determinar se um formato específico já está na coleção.

• O IndexOf método para recuperar o índice de um formato dentro da coleção.

• A Item[] propriedade para obter ou definir o formato em um índice específico, usando notação de matriz.

• O Clear método para remover todos os formatos da coleção.

• A Count propriedade para determinar o número de formatos na coleção.

• O IndexOf método para obter a posição de um formato dentro da coleção.

Construtores

DesignerAutoFormatCollection()

Inicializa uma nova instância da classe DesignerAutoFormatCollection.

Propriedades

Count	Obtém o número de objetos DesignerAutoFormat na coleção.
Item[Int32]	Obtém ou define um objeto DesignerAutoFormat no índice especificado na coleção.
PreviewSize	Obtém as dimensões externas máximas do controle como ele será exibido em tempo de execução.
SyncRoot	Obtém um objeto que pode ser usado para sincronizar o acesso ao objeto DesignerAutoFormatCollection.

Métodos

Add(DesignerAutoFormat)	Adiciona o objeto DesignerAutoFormat especificado ao final da coleção.
Clear()	Remove todos os formatos da coleção.
Contains(DesignerAutoFormat)	Determina se o formato especificado está contido na coleção.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IndexOf(DesignerAutoFormat)	Retorna o índice do objeto DesignerAutoFormat especificado na coleção.
Insert(Int32, DesignerAutoFormat)	Insere um objeto DesignerAutoFormat na coleção no índice especificado.
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
Remove(DesignerAutoFormat)	Remove o objeto DesignerAutoFormat especificado da coleção.
RemoveAt(Int32)	Remove o objeto DesignerAutoFormat no índice especificado dentro da coleção.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Implantações explícitas de interface

ICollection.CopyTo(Array, Int32)	Copia os elementos da coleção para um objeto Array, começando em um determinado índice Array quando o objeto DesignerAutoFormatCollection é convertido para uma interface ICollection.
ICollection.Count	Obtém o número de elementos contidos na coleção quando o objeto DesignerAutoFormatCollection é convertido para uma interface ICollection.
ICollection.IsSynchronized	Obtém um valor que indica se o acesso à coleção é sincronizado (thread-safe) quando o objeto DesignerAutoFormatCollection é convertido para uma interface ICollection.
IEnumerable.GetEnumerator()	Retorna uma interface IEnumerator que itera pela coleção quando o objeto DesignerAutoFormatCollection é convertido para uma interface IEnumerable.
IList.Add(Object)	Adiciona um item à coleção quando o objeto DesignerAutoFormatCollection é convertido para uma interface IList.
IList.Contains(Object)	Determina se a coleção contém um determinado valor quando o objeto DesignerAutoFormatCollection é convertido para uma interface IList.
IList.IndexOf(Object)	Determina o índice de um item específico na coleção quando o objeto DesignerAutoFormatCollection é convertido para uma interface IList.
IList.Insert(Int32, Object)	Insere um item na coleção no índice especificado quando o objeto DesignerAutoFormatCollection é convertido para uma interface IList.
IList.IsFixedSize	Obtém um valor que indica se a coleção tem um tamanho fixo quando o objeto DesignerAutoFormatCollection é convertido para uma interface IList.
IList.IsReadOnly	Para obter uma descrição desse método, consulte IsReadOnly.
IList.Item[Int32]	Obtém o elemento no índice especificado quando o objeto DesignerAutoFormatCollection é convertido para uma interface IList.
IList.Remove(Object)	Remove a primeira ocorrência de um objeto específico da coleção quando o objeto DesignerAutoFormatCollection é convertido para uma interface IList.
IList.RemoveAt(Int32)	Remove o item no índice especificado quando o objeto DesignerAutoFormatCollection é convertido para uma interface IList.

Métodos de Extensão

Cast<TResult>(IEnumerable)	Converte os elementos de um IEnumerable para o tipo especificado.
OfType<TResult>(IEnumerable)	Filtra os elementos de um IEnumerable com base em um tipo especificado.
AsParallel(IEnumerable)	Habilita a paralelização de uma consulta.
AsQueryable(IEnumerable)	Converte um IEnumerable em um IQueryable.

Confira também

• DesignerAutoFormat
• ControlDesigner
• AutoFormats
• DesignerAutoFormatStyle
• Visão geral dos Designers de Controle ASP.NET