Skip to main content
.NET Framework Class Library
DesignerActionListCollection Class

Represents a collection of DesignerActionList objects.

Inheritance Hierarchy
SystemObject
   System.CollectionsCollectionBase
    System.ComponentModel.DesignDesignerActionListCollection

Namespace:   System.ComponentModel.Design
Assembly:  System.Design (in System.Design.dll)
Syntax
<[%$TOPIC/51xwzwws_en-us_VS_110_3_0_0_0_0%](True)> _
<[%$TOPIC/51xwzwws_en-us_VS_110_3_0_0_0_1%]([%$TOPIC/51xwzwws_en-us_VS_110_3_0_0_0_2%].InheritanceDemand, Name := "FullTrust")> _
Public Class DesignerActionListCollection _
	Inherits [%$TOPIC/51xwzwws_en-us_VS_110_3_0_0_0_3%]
[[%$TOPIC/51xwzwws_en-us_VS_110_3_0_1_0_0%](true)]
[[%$TOPIC/51xwzwws_en-us_VS_110_3_0_1_0_1%]([%$TOPIC/51xwzwws_en-us_VS_110_3_0_1_0_2%].InheritanceDemand, Name = "FullTrust")]
public class DesignerActionListCollection : [%$TOPIC/51xwzwws_en-us_VS_110_3_0_1_0_3%]
[[%$TOPIC/51xwzwws_en-us_VS_110_3_0_2_0_0%](true)]
[[%$TOPIC/51xwzwws_en-us_VS_110_3_0_2_0_1%]([%$TOPIC/51xwzwws_en-us_VS_110_3_0_2_0_2%]::InheritanceDemand, Name = L"FullTrust")]
public ref class DesignerActionListCollection : public [%$TOPIC/51xwzwws_en-us_VS_110_3_0_2_0_3%]
[<[%$TOPIC/51xwzwws_en-us_VS_110_3_0_3_0_0%](true)>]
[<[%$TOPIC/51xwzwws_en-us_VS_110_3_0_3_0_1%]([%$TOPIC/51xwzwws_en-us_VS_110_3_0_3_0_2%].InheritanceDemand, Name = "FullTrust")>]
type DesignerActionListCollection =  
    class 
        inherit [%$TOPIC/51xwzwws_en-us_VS_110_3_0_3_0_3%] 
    end

The DesignerActionListCollection type exposes the following members.

Constructors
  NameDescription
Public method DesignerActionListCollectionInitializes a new instance of the DesignerActionListCollection class with default settings.
Public method DesignerActionListCollection(DesignerActionList)Initializes a new instance of the DesignerActionListCollection class with the specified panel items.
Top
Properties
  NameDescription
Public property CapacityGets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.)
Public property CountGets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.)
Protected property InnerListGets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Public property ItemGets or sets the element at the specified index.
Protected property ListGets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Top
Methods
  NameDescription
Public method AddAdds the supplied DesignerActionList to the current collection.
Public method AddRange(DesignerActionList)Adds the elements of the supplied DesignerActionList array to the end of the current collection.
Public method AddRange(DesignerActionListCollection)Adds the elements of the supplied DesignerActionListCollection to the end of the current collection.
Public method ClearRemoves all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.)
Public method ContainsIndicates whether the collection contains a specific value.
Public method CopyToCopies the elements of the current collection into the supplied array, starting at the specified array index.
Public method Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumeratorReturns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.)
Public method GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IndexOfDetermines the index of a specific item in the collection.
Public method InsertInserts the supplied DesignerActionList into the collection at the specified position.
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnClearPerforms additional custom processes when clearing the contents of the CollectionBase instance. (Overrides CollectionBaseOnClear.)
Protected method OnClearCompletePerforms additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnInsertPerforms additional custom processes before inserting a new element into the DesignerActionListCollection instance. (Overrides CollectionBaseOnInsert(Int32, Object).)
Protected method OnInsertCompletePerforms additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnRemovePerforms additional custom processes when removing an element from the DesignerActionListCollection instance. (Overrides CollectionBaseOnRemove(Int32, Object).)
Protected method OnRemoveCompletePerforms additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnSetPerforms additional custom processes before setting a value in the DesignerActionListCollection instance. (Overrides CollectionBaseOnSet(Int32, Object, Object).)
Protected method OnSetCompletePerforms additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnValidatePerforms additional custom processes when validating a value. (Overrides CollectionBaseOnValidate(Object).)
Public method RemoveRemoves the first occurrence of a specific DesignerActionList from the collection.
Public method RemoveAtRemoves the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method ICollectionCopyToCopies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.)
Explicit interface implemetation Private property ICollectionIsSynchronizedGets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.)
Explicit interface implemetation Private property ICollectionSyncRootGets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IListAddAdds an object to the end of the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IListContainsDetermines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IListIndexOfSearches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IListInsertInserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetation Private property IListIsFixedSizeGets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.)
Explicit interface implemetation Private property IListIsReadOnlyGets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.)
Explicit interface implemetation Private property IListItemGets or sets the element at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IListRemoveRemoves the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.)
Top
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.CollectionsCollectionBase class, DesignerActionListCollection uses an internal ArrayList to store its collection of DesignerActionList objects.

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 lists As DesignerActionListCollection
private DesignerActionListCollection 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
public override DesignerActionListCollection ActionLists
{
    get
    {
        if (null == actionLists)
        {
            actionLists = new DesignerActionListCollection();
            actionLists.Add(
                new ColorLabelActionList(this.Component));
        }
        return actionLists;
    }
}
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0
.NET Framework Security
Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.