This topic has not yet been rated - Rate this topic

DesignerVerb Class

Represents a verb that can be invoked from a designer.

Namespace:  System.ComponentModel.Design
Assembly:  System (in System.dll)
[ComVisibleAttribute(true)]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public class DesignerVerb : MenuCommand

The DesignerVerb type exposes the following members.

  Name Description
Public method DesignerVerb(String, EventHandler) Initializes a new instance of the DesignerVerb class.
Public method DesignerVerb(String, EventHandler, CommandID) Initializes a new instance of the DesignerVerb class.
Top
  Name Description
Public property Checked Gets or sets a value indicating whether this menu item is checked. (Inherited from MenuCommand.)
Public property CommandID Gets the CommandID associated with this menu command. (Inherited from MenuCommand.)
Public property Description Gets or sets the description of the menu item for the verb.
Public property Enabled Gets a value indicating whether this menu item is available. (Inherited from MenuCommand.)
Public property OleStatus Gets the OLE command status code for this menu item. (Inherited from MenuCommand.)
Public property Properties Gets the public properties associated with the MenuCommand. (Inherited from MenuCommand.)
Public property Supported Gets or sets a value indicating whether this menu item is supported. (Inherited from MenuCommand.)
Public property Text Gets the text description for the verb command on the menu.
Public property Visible Gets or sets a value indicating whether this menu item is visible. (Inherited from MenuCommand.)
Top
  Name Description
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 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Invoke() Invokes the command. (Inherited from MenuCommand.)
Public method Invoke(Object) Invokes the command with the given parameter. (Inherited from MenuCommand.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnCommandChanged Raises the CommandChanged event. (Inherited from MenuCommand.)
Public method ToString Overrides ToString. (Overrides MenuCommand.ToString().)
Top
  Name Description
Public event CommandChanged Occurs when the menu command changes. (Inherited from MenuCommand.)
Top

A designer verb is a menu command linked to an event handler. Designer verbs are added to a component's shortcut menu at design time. In Visual Studio, each designer verb is also listed, using a LinkLabel, in the Description pane of the Properties window.

Note Note

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following code example demonstrates how to create DesignerVerb objects and add them to the design-time shortcut menu for a component.


using System;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Collections;

/* This sample demonstrates a designer that adds menu commands
    to the design-time shortcut menu for a component.

    To test this sample, build the code for the component as a class library, 
    add the resulting component to the toolbox, open a form in design mode, 
    and drag the component from the toolbox onto the form. 

    The component should appear in the component tray beneath the form. 
    Right-click the component.  The verbs should appear in the shortcut menu.
*/

namespace CSDesignerVerb
{
    // Associate MyDesigner with this component type using a DesignerAttribute
    [Designer(typeof(MyDesigner))]
    public class Component1 : System.ComponentModel.Component
    {
    }

    // This is a designer class which provides designer verb menu commands for 
    // the associated component. This code is called by the design environment at design-time.
    internal class MyDesigner : ComponentDesigner
    {
        DesignerVerbCollection m_Verbs;

        // DesignerVerbCollection is overridden from ComponentDesigner
        public override DesignerVerbCollection Verbs
        {
            get 
            {
                if (m_Verbs == null) 
                {
                    // Create and initialize the collection of verbs
                    m_Verbs = new DesignerVerbCollection();
			
                    m_Verbs.Add( new DesignerVerb("First Designer Verb", new EventHandler(OnFirstItemSelected)) );
                    m_Verbs.Add( new DesignerVerb("Second Designer Verb", new EventHandler(OnSecondItemSelected)) );
                }
                return m_Verbs;
            }
        }

        MyDesigner() 
        {
        }

        private void OnFirstItemSelected(object sender, EventArgs args) 
        {
            // Display a message
            System.Windows.Forms.MessageBox.Show("The first designer verb was invoked.");
        }

        private void OnSecondItemSelected(object sender, EventArgs args) 
        {
            // Display a message
            System.Windows.Forms.MessageBox.Show("The second designer verb was invoked.");
        }
    }
}


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ