Export (0) Print
Expand All

DesignerActionListCollection Class

Represents a collection of DesignerActionList objects.

System::Object
  System.Collections::CollectionBase
    System.ComponentModel.Design::DesignerActionListCollection

Namespace:  System.ComponentModel.Design
Assembly:  System.Design (in System.Design.dll)

[ComVisibleAttribute(true)]
[PermissionSetAttribute(SecurityAction::InheritanceDemand, Name = L"FullTrust")]
public ref class DesignerActionListCollection : public CollectionBase

The DesignerActionListCollection type exposes the following members.

  NameDescription
Public methodDesignerActionListCollection()Initializes a new instance of the DesignerActionListCollection class with default settings.
Public methodDesignerActionListCollection(array<DesignerActionList>)Initializes a new instance of the DesignerActionListCollection class with the specified panel items.
Top

  NameDescription
Public propertyCapacityGets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.)
Public propertyCountGets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.)
Protected propertyInnerListGets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Public propertyItemGets or sets the element at the specified index.
Protected propertyListGets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Top

  NameDescription
Public methodAddAdds the supplied DesignerActionList to the current collection.
Public methodAddRange(array<DesignerActionList>)Adds the elements of the supplied DesignerActionList array to the end of the current collection.
Public methodAddRange(DesignerActionListCollection)Adds the elements of the supplied DesignerActionListCollection to the end of the current collection.
Public methodClearRemoves all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.)
Public methodContainsIndicates whether the collection contains a specific value.
Public methodCopyToCopies the elements of the current collection into the supplied array, starting at the specified array index.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfDetermines the index of a specific item in the collection.
Public methodInsertInserts the supplied DesignerActionList into the collection at the specified position.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnClearPerforms additional custom processes when clearing the contents of the CollectionBase instance. (Overrides CollectionBase::OnClear().)
Protected methodOnClearCompletePerforms additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodOnInsertPerforms additional custom processes before inserting a new element into the DesignerActionListCollection instance. (Overrides CollectionBase::OnInsert(Int32, Object).)
Protected methodOnInsertCompletePerforms additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodOnRemovePerforms additional custom processes when removing an element from the DesignerActionListCollection instance. (Overrides CollectionBase::OnRemove(Int32, Object).)
Protected methodOnRemoveCompletePerforms additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodOnSetPerforms additional custom processes before setting a value in the DesignerActionListCollection instance. (Overrides CollectionBase::OnSet(Int32, Object, Object).)
Protected methodOnSetCompletePerforms additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodOnValidatePerforms additional custom processes when validating a value. (Overrides CollectionBase::OnValidate(Object).)
Public methodRemoveRemoves the first occurrence of a specific DesignerActionList from the collection.
Public methodRemoveAtRemoves the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection::CopyToCopies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyICollection::IsSynchronizedGets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyICollection::SyncRootGets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList::AddAdds an object to the end of the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList::ContainsDetermines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList::IndexOfSearches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList::InsertInserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyIList::IsFixedSizeGets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyIList::IsReadOnlyGets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyIList::ItemGets or sets the element at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList::RemoveRemoves the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.)
Top

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.

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.

No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft