TemplateGroupCollection Classe

Définition

public ref class TemplateGroupCollection sealed : System::Collections::IList

public sealed class TemplateGroupCollection : System.Collections.IList

type TemplateGroupCollection = class
    interface IList
    interface ICollection
    interface IEnumerable

Public NotInheritable Class TemplateGroupCollection
Implements IList

Héritage

Object

TemplateGroupCollection

Implémente

ICollection IEnumerable IList

Exemples

L’exemple de code suivant montre comment définir un concepteur de contrôles simple dérivé de la ControlDesigner classe . Le concepteur de contrôles dérivé implémente la TemplateGroups propriété en obtenant les groupes de modèles définis pour la classe de base et en ajoutant un groupe de modèles spécifique au concepteur de contrôles dérivé.

using System;
using System.Web.UI;
using System.Web.UI.Design;
using System.Web.UI.WebControls;
using System.Web.UI.Design.WebControls;
using System.ComponentModel;
using System.ComponentModel.Design;

namespace Examples.AspNet
{
    // Define a simple control designer that adds a
    // template group to the template group collection.
    class DerivedControlDesigner : System.Web.UI.Design.ControlDesigner
    {
        private DerivedControl internalControl = null;

        private const String templateGroupName = "My template group";
        private const String templateDefinitionName1 = "First";
        private const String templateDefinitionName2 = "Second";
        private TemplateGroup internalGroup = null;

        // Override the read-only TemplateGroups property.
        // Get the base group collection, and add a group 
        // with two template definitions for the derived
        // control designer.
        public override TemplateGroupCollection TemplateGroups
        {
            get
            {
                // Start with the groups defined by the base designer class.
                TemplateGroupCollection groups = base.TemplateGroups;

                if (internalGroup == null) 
                {
                    // Define a new group with two template definitions.
                    internalGroup = new TemplateGroup(templateGroupName, 
                                                internalControl.ControlStyle);

                    TemplateDefinition templateDef1 = new TemplateDefinition(this, 
                        templateDefinitionName1, internalControl, 
                        templateDefinitionName1, internalControl.ControlStyle);

                    TemplateDefinition templateDef2 = new TemplateDefinition(this, 
                        templateDefinitionName2, internalControl, 
                        templateDefinitionName2, internalControl.ControlStyle);

                    internalGroup.AddTemplateDefinition(templateDef1);
                    internalGroup.AddTemplateDefinition(templateDef2);
                }

                // Add the new template group to the collection.
                groups.Add(internalGroup);

                return groups;
            }
        }
    }

    // Define a simple web control, and associate it with the designer.
    [DesignerAttribute(typeof(DerivedControlDesigner),
                       typeof(IDesigner))]
    public class DerivedControl : WebControl
    {
        // Define derived control behavior here.
    }
}

Imports System.Web.UI
Imports System.Web.UI.Design
Imports System.Web.UI.WebControls
Imports System.Web.UI.Design.WebControls
Imports System.ComponentModel
Imports System.ComponentModel.Design

Namespace Examples.AspNet

    ' Define a simple control designer that adds a
    ' template group to the template group collection.
    Class DerivedControlDesigner
        Inherits System.Web.UI.Design.ControlDesigner

        Private Dim internalControl As DerivedControl = Nothing
    
        Private Const templateGroupName As String = "My template group"
        Private Const templateDefinitionName1 As String = "First"
        Private Const templateDefinitionName2 As String = "Second"
        Private Dim internalGroup As TemplateGroup = Nothing

        ' Override the read-only TemplateGroups property.
        ' Get the base group collection, and add a group 
        ' with two template definitions for the derived
        ' control designer.
        Public Overrides ReadOnly Property TemplateGroups As TemplateGroupCollection
            Get

                ' Start with the groups defined by the base designer class.
                Dim groups As TemplateGroupCollection  = MyBase.TemplateGroups

                If internalGroup Is Nothing

                    ' Define a new group with two template definitions.
                    internalGroup = New TemplateGroup(templateGroupName, _
                                                internalControl.ControlStyle)

                    Dim templateDef1 As TemplateDefinition = new TemplateDefinition(Me, _
                        templateDefinitionName1, internalControl, _
                        templateDefinitionName1, internalControl.ControlStyle)

                    Dim templateDef2 As TemplateDefinition = new TemplateDefinition(Me, _
                        templateDefinitionName2, internalControl, _
                        templateDefinitionName2, internalControl.ControlStyle)

                    internalGroup.AddTemplateDefinition(templateDef1)
                    internalGroup.AddTemplateDefinition(templateDef2)

                End If

                ' Add the new template group to the collection.
                groups.Add(internalGroup)

                return groups
            End Get
        End Property

    End Class

    ' Simple Web control, derived from the Web control class.
    <DesignerAttribute(GetType(DerivedControlDesigner), GetType(IDesigner))> _
    Public Class DerivedControl
        Inherits WebControl
        
        ' Define derived control behavior here.
    End Class

End Namespace

Remarques

La ControlDesigner classe, et toute classe dérivée, définit la TemplateGroups propriété en tant qu’objet TemplateGroupCollection . La TemplateGroupCollection propriété est généralement utilisée uniquement par un hôte de conception tel que Visual Studio 2005.

La collection augmente dynamiquement en taille à mesure que des objets sont ajoutés. Les index de cette collection sont de base zéro. Utilisez la Count propriété pour déterminer le nombre de groupes dans la collection.

En outre, utilisez les TemplateGroupCollection méthodes et propriétés pour fournir les fonctionnalités suivantes :

• Méthode Add permettant d’ajouter un groupe unique à la collection.

• Méthode Insert permettant d’ajouter un groupe à un index particulier au sein de la collection.

• Méthode Remove permettant de supprimer un groupe.

• Méthode RemoveAt permettant de supprimer le groupe à un index particulier.

• Méthode Contains permettant de déterminer si un groupe particulier se trouve déjà dans la collection.

• Méthode IndexOf permettant de récupérer l’index d’un groupe au sein de la collection.

• Indexeur Item[] permettant d’obtenir ou de définir le groupe sur un index particulier, à l’aide de la notation de tableau.

• Méthode AddRange permettant d’ajouter plusieurs groupes à la collection.

  Vous pouvez ajouter plusieurs groupes sous forme de tableau de groupes ou d’objet TemplateGroupCollection que vous récupérez via la TemplateGroups propriété d’un autre concepteur de contrôles.

• Méthode Clear permettant de supprimer tous les groupes de la collection.

Constructeurs

Propriétés

Méthodes

Implémentations d’interfaces explicites

Méthodes d’extension

S’applique à

Voir aussi

• TemplateGroups
• TemplateGroup
• TemplateDefinition
• vue d’ensemble des concepteurs de contrôle ASP.NET
• Extension de la prise en charge au moment du design
• Comment : étendre l'apparence et le comportement des contrôles en mode design