ListItemsCollectionEditor Class

Reference

Definition

Namespace:: System.Web.UI.Design.WebControls

Assembly:: System.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 component editor for ListItemCollection objects in a control that is derived from the ListControl or a similar control.

public ref class ListItemsCollectionEditor : System::ComponentModel::Design::CollectionEditor

public class ListItemsCollectionEditor : System.ComponentModel.Design.CollectionEditor

type ListItemsCollectionEditor = class
    inherit CollectionEditor

Public Class ListItemsCollectionEditor
Inherits CollectionEditor

Inheritance: Object

UITypeEditor

CollectionEditor
ListItemsCollectionEditor

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.

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

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

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.

Constructors

ListItemsCollectionEditor(Type)

Initializes a new instance of the ListItemsCollectionEditor class.

Properties

CollectionItemType	Gets the data type of each item in the collection. (Inherited from CollectionEditor)
CollectionType	Gets the data type of the collection object. (Inherited from CollectionEditor)
Context	Gets a type descriptor that indicates the current context. (Inherited from CollectionEditor)
HelpTopic	Gets the Help topic to display for the ListItemsCollectionEditor object.
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. (Inherited from CollectionEditor)
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. (Inherited from CollectionEditor)

Methods

CancelChanges()	Cancels changes to the collection. (Inherited from CollectionEditor)
CanRemoveInstance(Object)	Indicates whether original members of the collection can be removed. (Inherited from CollectionEditor)
CanSelectMultipleInstances()	Gets a value indicating whether multiple ListItem elements can be selected at one time.
CreateCollectionForm()	Creates a new form to display and edit the current collection. (Inherited from CollectionEditor)
CreateCollectionItemType()	Gets the data type that this collection contains. (Inherited from CollectionEditor)
CreateInstance(Type)	Creates a new instance of the specified collection item type. (Inherited from CollectionEditor)
CreateNewItemTypes()	Gets the data types that this collection editor can contain. (Inherited from CollectionEditor)
DestroyInstance(Object)	Destroys the specified instance of the object. (Inherited from CollectionEditor)
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. (Inherited from CollectionEditor)
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. (Inherited from CollectionEditor)
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. (Inherited from CollectionEditor)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetItems(Object)	Gets an array of objects containing the specified collection. (Inherited from CollectionEditor)
GetObjectsFromInstance(Object)	Returns a list containing the given object. (Inherited from CollectionEditor)
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. (Inherited from CollectionEditor)
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. (Inherited from CollectionEditor)
ShowHelp()	Displays the default Help topic for the collection editor. (Inherited from CollectionEditor)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via