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

Switch View :
ScriptFree
.NET Framework Class Library
MenuItemCollectionEditor Class

Provides a component editor for the collection that is specified by the Items property of the associated Menu control.

Inheritance Hierarchy

System.Object
  System.Drawing.Design.UITypeEditor
    System.Web.UI.Design.WebControls.MenuItemCollectionEditor

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

Visual Basic
Public Class MenuItemCollectionEditor _
	Inherits UITypeEditor
C#
public class MenuItemCollectionEditor : UITypeEditor
Visual C++
public ref class MenuItemCollectionEditor : public UITypeEditor
F#
type MenuItemCollectionEditor =  
    class
        inherit UITypeEditor
    end

The MenuItemCollectionEditor type exposes the following members.

Constructors

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

  Name Description
Public property IsDropDownResizable Gets a value indicating whether drop-down editors should be resizable by the user. (Inherited from UITypeEditor.)
Top
Methods

  Name Description
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 menu item collection of the associated control. (Overrides UITypeEditor.EditValue(ITypeDescriptorContext, IServiceProvider, Object).)
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.)
Public method GetEditStyle() Gets the editor style used by the EditValue method. (Inherited from UITypeEditor.)
Public method GetEditStyle(ITypeDescriptorContext) Gets the editing style that is associated with this editor. (Overrides UITypeEditor.GetEditStyle(ITypeDescriptorContext).)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
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.)
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.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

The MenuItemCollectionEditor class provides a user interface for editing the MenuItem elements of the collection that is specified by the Items property within the associated Menu control.

The MenuItemCollectionEditor is invoked by selecting the ellipsis () button on the Items property in the Properties grid of the visual designer, or by choosing Edit Menu Items from the Common Tasks context menu on the control.

The EditValue method edits the values of the menu item collection of the associated Menu control. The GetEditStyle method gets the editing style that is associated with this editor.

Examples

The following code example shows how to use the EditorAttribute attribute to associate the MenuItemCollectionEditor and UITypeEditor (the collection editor base class) classes with a property in a custom control, derived from the WebControl class, that gets and sets a MenuItemCollection collection.

Visual Basic

Private menuItems As MenuItemCollection

' Associate the MenuItemCollectionEditor with the Items.
<EditorAttribute( GetType(System.Web.UI.Design.WebControls. _
    MenuItemCollectionEditor), _
    GetType(UITypeEditor))> _
Public Property Items() As MenuItemCollection
    Get
        If menuItems Is Nothing Then
            menuItems = New MenuItemCollection()
        End If
        Return menuItems
    End Get
    Set
        menuItems = value
    End Set
End Property ' Items


C#

private MenuItemCollection menuItems;

// Associate the MenuItemCollectionEditor with the Items. 
[Editor(typeof(System.Web.UI.Design.WebControls.
    MenuItemCollectionEditor),
    typeof(UITypeEditor))]
public MenuItemCollection Items
{
    get
    {
        // If there is no menuItems collection, create it.
        if (menuItems == null)
            menuItems = new MenuItemCollection();

        return menuItems;
    }
    set { menuItems = value; }
} // Items


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.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