CollectionEditor Class

 

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

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


public class CollectionEditor : UITypeEditor

NameDescription
System_CAPS_pubmethodCollectionEditor(Type)

Initializes a new instance of the CollectionEditor class using the specified collection type.

NameDescription
System_CAPS_protpropertyCollectionItemType

Gets the data type of each item in the collection.

System_CAPS_protpropertyCollectionType

Gets the data type of the collection object.

System_CAPS_protpropertyContext

Gets a type descriptor that indicates the current context.

System_CAPS_protpropertyHelpTopic

Gets 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.

System_CAPS_pubpropertyIsDropDownResizable

Gets a value indicating whether drop-down editors should be resizable by the user.(Inherited from UITypeEditor.)

System_CAPS_protpropertyNewItemTypes

Gets the available types of items that can be created for this collection.

NameDescription
System_CAPS_protmethodCancelChanges()

Cancels changes to the collection.

System_CAPS_protmethodCanRemoveInstance(Object)

Indicates whether original members of the collection can be removed.

System_CAPS_protmethodCanSelectMultipleInstances()

Indicates whether multiple collection items can be selected at once.

System_CAPS_protmethodCreateCollectionForm()

Creates a new form to display and edit the current collection.

System_CAPS_protmethodCreateCollectionItemType()

Gets the data type that this collection contains.

System_CAPS_protmethodCreateInstance(Type)

Creates a new instance of the specified collection item type.

System_CAPS_protmethodCreateNewItemTypes()

Gets the data types that this collection editor can contain.

System_CAPS_protmethodDestroyInstance(Object)

Destroys the specified instance of the object.

System_CAPS_pubmethodEditValue(IServiceProvider, Object)

Edits the value of the specified object using the editor style indicated by the GetEditStyle method.(Inherited from UITypeEditor.)

System_CAPS_pubmethodEditValue(ITypeDescriptorContext, IServiceProvider, Object)

Edits the value of the specified object using the specified service provider and context.(Overrides UITypeEditor.EditValue(ITypeDescriptorContext, IServiceProvider, Object).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodGetDisplayText(Object)

Retrieves the display text for the given list item.

System_CAPS_pubmethodGetEditStyle()

Gets the editor style used by the EditValue method.(Inherited from UITypeEditor.)

System_CAPS_pubmethodGetEditStyle(ITypeDescriptorContext)

Gets the edit style used by the EditValue method.(Overrides UITypeEditor.GetEditStyle(ITypeDescriptorContext).)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_protmethodGetItems(Object)

Gets an array of objects containing the specified collection.

System_CAPS_protmethodGetObjectsFromInstance(Object)

Returns a list containing the given object

System_CAPS_pubmethodGetPaintValueSupported()

Indicates whether this editor supports painting a representation of an object's value.(Inherited from UITypeEditor.)

System_CAPS_pubmethodGetPaintValueSupported(ITypeDescriptorContext)

Indicates whether the specified context supports painting a representation of an object's value within the specified context.(Inherited from UITypeEditor.)

System_CAPS_protmethodGetService(Type)

Gets the requested service, if it is available.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodPaintValue(Object, Graphics, Rectangle)

Paints a representation of the value of the specified object to the specified canvas.(Inherited from UITypeEditor.)

System_CAPS_pubmethodPaintValue(PaintValueEventArgs)

Paints a representation of the value of an object using the specified PaintValueEventArgs.(Inherited from UITypeEditor.)

System_CAPS_protmethodSetItems(Object, Object[])

Sets the specified array as the items of the collection.

System_CAPS_protmethodShowHelp()

Displays the default Help topic for the collection editor.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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
Available since 1.1

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

Return to top
Show: