TemplateGroupCollection Klasse

Definition

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

Vererbung

Object

TemplateGroupCollection

Implementiert

ICollection IEnumerable IList

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie ein einfacher Steuerelement-Designer definiert wird, der von der ControlDesigner -Klasse abgeleitet ist. Der abgeleitete Steuerelement-Designer implementiert die TemplateGroups -Eigenschaft, indem er die Vorlagengruppen erhält, die für die Basisklasse definiert sind, und eine Vorlagengruppe hinzufügt, die für den abgeleiteten Steuerelement-Designer spezifisch ist.

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

Hinweise

Die ControlDesigner -Klasse und jede abgeleitete Klasse definieren die TemplateGroups -Eigenschaft als TemplateGroupCollection -Objekt. Die TemplateGroupCollection Eigenschaft wird in der Regel nur von einem Designhost wie Visual Studio 2005 verwendet.

Die Auflistung nimmt dynamisch an Größe zu, wenn Objekte hinzugefügt werden. Indizes in dieser Auflistung sind nullbasiert. Verwenden Sie die Count -Eigenschaft, um zu bestimmen, wie viele Gruppen sich in der Auflistung befinden.

Verwenden Sie außerdem die TemplateGroupCollection Methoden und Eigenschaften, um die folgende Funktionalität bereitzustellen:

• Die Add Methode zum Hinzufügen einer einzelnen Gruppe zur Auflistung.

• Die Insert Methode zum Hinzufügen einer Gruppe an einem bestimmten Index innerhalb der Auflistung.

• Die Remove Methode zum Entfernen einer Gruppe.

• Die RemoveAt Methode zum Entfernen der Gruppe an einem bestimmten Index.

• Die Contains Methode, um zu bestimmen, ob sich eine bestimmte Gruppe bereits in der Auflistung befindet.

• Die IndexOf Methode zum Abrufen des Indexes einer Gruppe innerhalb der Auflistung.

• Der Item[] Indexer zum Abrufen oder Festlegen der Gruppe auf einen bestimmten Index mithilfe der Arraynotation.

• Die AddRange Methode zum Hinzufügen mehrerer Gruppen zur Auflistung.

  Sie können mehrere Gruppen entweder als Array von Gruppen oder als TemplateGroupCollection Objekt hinzufügen, das Sie über die TemplateGroups Eigenschaft eines anderen Steuerelement-Designers abrufen.

• Die Clear Methode zum Entfernen aller Gruppen aus der Auflistung.

Konstruktoren

Eigenschaften

Methoden

Explizite Schnittstellenimplementierungen

Erweiterungsmethoden

Gilt für:

Weitere Informationen

• TemplateGroups
• TemplateGroup
• TemplateDefinition
• Übersicht über ASP.NET-Steuerelement-Designer
• Erweitern der Entwurfszeitunterstützung
• Gewusst wie: Erweitern der Darstellung und des Verhaltens von Steuerelementen im Entwurfsmodus