ListItemsCollectionEditor Class (System.Web.UI.Design.WebControls)

Switch View :
ScriptFree
.NET Framework Class Library
ListItemsCollectionEditor Class

Provides a component editor for ListItemCollection objects in a control that is derived from the ListControl or a similar control.

Inheritance Hierarchy

System.Object
  System.Drawing.Design.UITypeEditor
    System.ComponentModel.Design.CollectionEditor
      System.Web.UI.Design.WebControls.ListItemsCollectionEditor

Namespace:  System.Web.UI.Design.WebControls
Assembly:  System.Design (in System.Design.dll)
Syntax

Visual Basic
<SecurityPermissionAttribute(SecurityAction.Demand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Public Class ListItemsCollectionEditor _
	Inherits CollectionEditor
C#
[SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public class ListItemsCollectionEditor : CollectionEditor
Visual C++
[SecurityPermissionAttribute(SecurityAction::Demand, Flags = SecurityPermissionFlag::UnmanagedCode)]
public ref class ListItemsCollectionEditor : public CollectionEditor
F#
[<SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
type ListItemsCollectionEditor =  
    class
        inherit CollectionEditor
    end

The ListItemsCollectionEditor type exposes the following members.

Constructors

  Name Description
Public method ListItemsCollectionEditor Infrastructure. Initializes a new instance of the ListItemsCollectionEditor class.
Top
Properties

  Name Description
Protected property CollectionItemType Gets the data type of each item in the collection. (Inherited from CollectionEditor.)
Protected property CollectionType Gets the data type of the collection object. (Inherited from CollectionEditor.)
Protected property Context Gets a type descriptor that indicates the current context. (Inherited from CollectionEditor.)
Protected property HelpTopic Gets the Help topic to display for the ListItemsCollectionEditor object. (Overrides CollectionEditor.HelpTopic.)
Public property IsDropDownResizable Gets a value indicating whether drop-down editors should be resizable by the user. (Inherited from UITypeEditor.)
Protected property NewItemTypes Gets the available types of items that can be created for this collection. (Inherited from CollectionEditor.)
Top
Methods

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

The ListItemsCollectionEditor class provides a user interface for editing the ListItem elements of the ListItemCollection object within a control that is derived from the ListControl or a similar control.

The ListItemsCollectionEditor is invoked by selecting the ellipsis () button on the ListItems property in the Properties grid of the visual designer.

The CanSelectMultipleInstances method always returns false to indicate that only one object can be selected at a time in the editor. The HelpTopic property returns the name of the Help topic that the editor displays.

Examples

The following code example shows how to use the EditorAttribute class to associate the ListItemsCollectionEditor class and the UITypeEditor class (the collection editor's base class) with a custom ListItems property.

Visual Basic

Private items As ListItemCollection

' Associate the ListItemsCollectionEditor with the ListItems.
<EditorAttribute( GetType(System.Web.UI.Design.WebControls. _
    ListItemsCollectionEditor), _
    GetType(UITypeEditor))> _
Public ReadOnly Property ListItems() As ListItemCollection
    Get
        Return items
    End Get
End Property ' ListItems


C#

private ListItemCollection items = null;

// Associate the ListItemsCollectionEditor with the ListItems. 
[EditorAttribute(typeof(System.Web.UI.Design.WebControls.
   ListItemsCollectionEditor),
   typeof(UITypeEditor))]
public ListItemCollection ListItems
{
    get { return items; }
} // ListItems


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
See Also

Reference

Other Resources