CollectionEditor Class

Reference

Definition

Namespace:: System.ComponentModel.Design

Assembly:: System.Design.dll

Assembly:: System.Windows.Forms.Design.Editors.dll

Assembly:: System.Windows.Forms.Design.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class CollectionEditor : System::Drawing::Design::UITypeEditor

public class CollectionEditor : System.Drawing.Design.UITypeEditor

type CollectionEditor = class
    inherit UITypeEditor

Public Class CollectionEditor
Inherits UITypeEditor

Inheritance: Object

UITypeEditor
CollectionEditor

Derived: System.ComponentModel.Design.ArrayEditor

System.Web.DynamicData.Design.DataControlReferenceCollectionEditor

System.Web.UI.Design.CollectionEditorBase

System.Web.UI.Design.WebControls.EmbeddedMailObjectCollectionEditor

System.Web.UI.Design.WebControls.HotSpotCollectionEditor

More…

Examples

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

public:
   [EditorAttribute(System::ComponentModel::Design::CollectionEditor::typeid,
      System::Drawing::Design::UITypeEditor::typeid)]
   property ICollection^ testCollection 
   {
      ICollection^ get()
      {
         return Icollection;
      }
      void set( ICollection^ value )
      {
         Icollection = value;
      }
   }
private:
   ICollection^ Icollection;

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

<EditorAttribute(GetType(System.ComponentModel.Design.CollectionEditor), GetType(System.Drawing.Design.UITypeEditor))>  _
Public Property testCollection() As ICollection
   Get
      Return Icollection
   End Get
   Set
      Icollection = value
   End Set
End Property
Private Icollection As ICollection

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.

Constructors

CollectionEditor(Type)

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

Properties

CollectionItemType	Gets the data type of each item in the collection.
CollectionType	Gets the data type of the collection object.
Context	Gets a type descriptor that indicates the current context.
HelpTopic	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.
IsDropDownResizable	Gets a value indicating whether drop-down editors should be resizable by the user. (Inherited from UITypeEditor)
NewItemTypes	Gets the available types of items that can be created for this collection.

Methods

CancelChanges()	Cancels changes to the collection.
CanRemoveInstance(Object)	Indicates whether original members of the collection can be removed.
CanSelectMultipleInstances()	Indicates whether multiple collection items can be selected at once.
CreateCollectionForm()	Creates a new form to display and edit the current collection.
CreateCollectionItemType()	Gets the data type that this collection contains.
CreateInstance(Type)	Creates a new instance of the specified collection item type.
CreateNewItemTypes()	Gets the data types that this collection editor can contain.
DestroyInstance(Object)	Destroys the specified instance of the object.
EditValue(IServiceProvider, Object)	Edits the value of the specified object using the editor style indicated by the GetEditStyle() method. (Inherited from UITypeEditor)
EditValue(ITypeDescriptorContext, IServiceProvider, Object)	Edits the value of the specified object using the specified service provider and context.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetDisplayText(Object)	Retrieves the display text for the given list item.
GetEditStyle()	Gets the editor style used by the EditValue(IServiceProvider, Object) method. (Inherited from UITypeEditor)
GetEditStyle(ITypeDescriptorContext)	Gets the edit style used by the EditValue(ITypeDescriptorContext, IServiceProvider, Object) method.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetItems(Object)	Gets an array of objects containing the specified collection.
GetObjectsFromInstance(Object)	Returns a list containing the given object.
GetPaintValueSupported()	Indicates whether this editor supports painting a representation of an object's value. (Inherited from UITypeEditor)
GetPaintValueSupported(ITypeDescriptorContext)	Indicates whether the specified context supports painting a representation of an object's value within the specified context. (Inherited from UITypeEditor)
GetService(Type)	Gets the requested service, if it is available.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
PaintValue(Object, Graphics, Rectangle)	Paints a representation of the value of the specified object to the specified canvas. (Inherited from UITypeEditor)
PaintValue(PaintValueEventArgs)	Paints a representation of the value of an object using the specified PaintValueEventArgs. (Inherited from UITypeEditor)
SetItems(Object, Object[])	Sets the specified array as the items of the collection.
ShowHelp()	Displays the default Help topic for the collection editor.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via