Export (0) Print
Expand All

CollectionEditor Class

Provides a user interface that can edit most types of collections at design time.

System.Object
  System.Drawing.Design.UITypeEditor
    System.ComponentModel.Design.CollectionEditor
      More...

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

public class CollectionEditor : UITypeEditor

The CollectionEditor type exposes the following members.

  NameDescription
Public methodCollectionEditorInitializes a new instance of the CollectionEditor class using the specified collection type.
Top

  NameDescription
Protected propertyCollectionItemTypeGets the data type of each item in the collection.
Protected propertyCollectionTypeGets the data type of the collection object.
Protected propertyContextGets a type descriptor that indicates the current context.
Protected propertyHelpTopicGets the Help keyword to display the Help topic or topic list for when the editor's dialog box Help button or the F1 key is pressed.
Public propertyIsDropDownResizableGets a value indicating whether drop-down editors should be resizable by the user. (Inherited from UITypeEditor.)
Protected propertyNewItemTypesGets the available types of items that can be created for this collection.
Top

  NameDescription
Protected methodCancelChangesCancels changes to the collection.
Protected methodCanRemoveInstanceIndicates whether original members of the collection can be removed.
Protected methodCanSelectMultipleInstancesIndicates whether multiple collection items can be selected at once.
Protected methodCreateCollectionFormCreates a new form to display and edit the current collection.
Protected methodCreateCollectionItemTypeGets the data type that this collection contains.
Protected methodCreateInstanceCreates a new instance of the specified collection item type.
Protected methodCreateNewItemTypesGets the data types that this collection editor can contain.
Protected methodDestroyInstanceDestroys the specified instance of the object.
Public methodEditValue(IServiceProvider, Object)Edits the value of the specified object using the editor style indicated by the GetEditStyle method. (Inherited from UITypeEditor.)
Public methodEditValue(ITypeDescriptorContext, IServiceProvider, Object)Edits the value of the specified object using the specified service provider and context. (Overrides UITypeEditor.EditValue(ITypeDescriptorContext, IServiceProvider, Object).)
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.)
Protected methodGetDisplayTextRetrieves the display text for the given list item.
Public methodGetEditStyle()Gets the editor style used by the EditValue method. (Inherited from UITypeEditor.)
Public methodGetEditStyle(ITypeDescriptorContext)Gets the edit style used by the EditValue method. (Overrides UITypeEditor.GetEditStyle(ITypeDescriptorContext).)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetItemsGets an array of objects containing the specified collection.
Protected methodGetObjectsFromInstanceReturns a list containing the given object
Public methodGetPaintValueSupported()Indicates whether this editor supports painting a representation of an object's value. (Inherited from UITypeEditor.)
Public methodGetPaintValueSupported(ITypeDescriptorContext)Indicates whether the specified context supports painting a representation of an object's value within the specified context. (Inherited from UITypeEditor.)
Protected methodGetServiceGets the requested service, if it is available.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPaintValue(PaintValueEventArgs)Paints a representation of the value of an object using the specified PaintValueEventArgs. (Inherited from UITypeEditor.)
Public methodPaintValue(Object, Graphics, Rectangle)Paints a representation of the value of the specified object to the specified canvas. (Inherited from UITypeEditor.)
Protected methodSetItemsSets the specified array as the items of the collection.
Protected methodShowHelpDisplays the default Help topic for the collection editor.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Notes to Inheritors

This editor can edit collections that have an Item property. The editor can determine the type of the collection from the Item property, if it exists. If the collection does not have this property, or if you want to provide collections of more than one type, you can override certain protected members of this class to customize the editor to support other types of collections.

The following code example uses an EditorAttribute to associate the CollectionEditor with a property.

[EditorAttribute(typeof(System.ComponentModel.Design.CollectionEditor), typeof(System.Drawing.Design.UITypeEditor))]
public ICollection testCollection
{
    get
    {
        return Icollection;
    }
    set
    {
        Icollection = value;
    }
}
private ICollection Icollection;

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.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