DesignerActionListCollection Class

Definition

Namespace:

System.ComponentModel.Design

Assembly:

System.Windows.Forms.Design.dll

Represents a collection of DesignerActionList objects.

public ref class DesignerActionListCollection : System::Collections::CollectionBase

public class DesignerActionListCollection : System.Collections.CollectionBase

type DesignerActionListCollection = class
    inherit CollectionBase

Public Class DesignerActionListCollection
Inherits CollectionBase

Inheritance

Object

CollectionBase

DesignerActionListCollection

Examples

The following code example demonstrates how to create a collection of DesignerActionItem objects.

For a full example, see How to: Attach Smart Tags to a Windows Forms Component.

private DesignerActionListCollection actionLists;

Private lists As DesignerActionListCollection

public override DesignerActionListCollection ActionLists
{
    get
    {
        if (null == actionLists)
        {
            actionLists = new DesignerActionListCollection();
            actionLists.Add(
                new ColorLabelActionList(this.Component));
        }
        return actionLists;
    }
}

Public Overrides ReadOnly Property ActionLists() _
As DesignerActionListCollection
    Get
        If lists Is Nothing Then
            lists = New DesignerActionListCollection()
            lists.Add( _
            New ColorLabelActionList(Me.Component))
        End If
        Return lists
    End Get
End Property

Remarks

The DesignerActionListCollection class represents the aggregation of all the items in a smart tag panel. The DesignerActionListCollection class contains zero or more DesignerActionList objects. Each of these lists contains zero or more objects that represent the actual items in the panel and are derived from the DesignerActionItem class.

The following table shows the two techniques for supplying a DesignerActionListCollection to populate the panel with items for components, including custom controls.

Technique	Description
Pull model	The designer for the component class, which is derived from the ComponentDesigner class, supplies this collection through the ActionLists property. The designer infrastructure reads this property when it must display the panel.
Push model	A DesignerActionList or DesignerActionListCollection is supplied as a parameter in a call to the Add method of the DesignerActionService associated with the component.

The designer infrastructure constructs a panel by creating a smart tag panel, whose constructor takes two parameters of type DesignerActionListCollection. The collections of lists, which contain the pulled and pushed items, are merged into one panel.

Because it derives from the System.Collections.CollectionBase class, DesignerActionListCollection uses an internal ArrayList to store its collection of DesignerActionList objects.

Constructors

DesignerActionListCollection()	Initializes a new instance of the DesignerActionListCollection class with default settings.
DesignerActionListCollection(DesignerActionList[])	Initializes a new instance of the DesignerActionListCollection class with the specified panel items.

Properties

Capacity	Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase)
Count	Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase)
InnerList	Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase)
Item[Int32]	Gets or sets the element at the specified index.
List	Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase)

Methods

Add(DesignerActionList)	Adds the supplied DesignerActionList to the current collection.
AddRange(DesignerActionList[])	Adds the elements of the supplied DesignerActionList array to the end of the current collection.
AddRange(DesignerActionListCollection)	Adds the elements of the supplied DesignerActionListCollection to the end of the current collection.
Clear()	Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase)
Contains(DesignerActionList)	Indicates whether the collection contains a specific value.
CopyTo(DesignerActionList[], Int32)	Copies the elements of the current collection into the supplied array, starting at the specified array index.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IndexOf(DesignerActionList)	Determines the index of a specific item in the collection.
Insert(Int32, DesignerActionList)	Inserts the supplied DesignerActionList into the collection at the specified position.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnClear()	Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase)
OnClearComplete()	Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase)
OnInsert(Int32, Object)	Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase)
OnInsertComplete(Int32, Object)	Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase)
OnRemove(Int32, Object)	Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase)
OnRemoveComplete(Int32, Object)	Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase)
OnSet(Int32, Object, Object)	Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase)
OnSetComplete(Int32, Object, Object)	Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase)
OnValidate(Object)	Performs additional custom processes when validating a value.
Remove(DesignerActionList)	Removes the first occurrence of a specific DesignerActionList from the collection.
RemoveAt(Int32)	Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

See also

• DesignerActionItem
• DesignerActionList
• ActionLists
• Add
• ArrayList
• Designer Commands and the DesignerAction Object Model for Windows Forms