DesignerVerb Class

Represents a verb that can be invoked from a designer.

Namespace:  System.ComponentModel.Design
Assembly:  System (in System.dll)

[ComVisibleAttribute(true)]
[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)]
[PermissionSetAttribute(SecurityAction::LinkDemand, Name = L"FullTrust")]
[PermissionSetAttribute(SecurityAction::InheritanceDemand, Name = L"FullTrust")]
public ref class DesignerVerb : public MenuCommand

The DesignerVerb type exposes the following members.

  NameDescription
Public methodDesignerVerb(String, EventHandler)Initializes a new instance of the DesignerVerb class.
Public methodDesignerVerb(String, EventHandler, CommandID)Initializes a new instance of the DesignerVerb class.
Top

  NameDescription
Public propertyCheckedGets or sets a value indicating whether this menu item is checked. (Inherited from MenuCommand.)
Public propertyCommandIDGets the CommandID associated with this menu command. (Inherited from MenuCommand.)
Public propertyDescriptionGets or sets the description of the menu item for the verb.
Public propertyEnabledGets a value indicating whether this menu item is available. (Inherited from MenuCommand.)
Public propertyOleStatusGets the OLE command status code for this menu item. (Inherited from MenuCommand.)
Public propertyPropertiesGets the public properties associated with the MenuCommand. (Inherited from MenuCommand.)
Public propertySupportedGets or sets a value indicating whether this menu item is supported. (Inherited from MenuCommand.)
Public propertyTextGets the text description for the verb command on the menu.
Public propertyVisibleGets or sets a value indicating whether this menu item is visible. (Inherited from MenuCommand.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInvoke()Invokes the command. (Inherited from MenuCommand.)
Public methodInvoke(Object)Invokes the command with the given parameter. (Inherited from MenuCommand.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnCommandChangedRaises the CommandChanged event. (Inherited from MenuCommand.)
Public methodToStringOverrides ToString. (Overrides MenuCommand::ToString().)
Top

  NameDescription
Public eventCommandChangedOccurs 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.

NoteNote

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.dll>
#using <system.design.dll>
#using <system.windows.forms.dll>

using namespace System;
using namespace System::ComponentModel;
using namespace System::ComponentModel::Design;
using namespace System::Windows::Forms;

/* 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.
*/ 
// 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. 
private ref class MyDesigner: public ComponentDesigner
{
public:

   property DesignerVerbCollection^ Verbs 
   {
      // DesignerVerbCollection is overridden from ComponentDesigner 
      virtual DesignerVerbCollection^ get() override
      {
         if ( m_Verbs == nullptr )
         {
            // Create and initialize the collection of verbs
            m_Verbs = gcnew DesignerVerbCollection;
            m_Verbs->Add( gcnew DesignerVerb( "First Designer Verb",gcnew EventHandler( this, &MyDesigner::OnFirstItemSelected ) ) );
            m_Verbs->Add( gcnew DesignerVerb( "Second Designer Verb",gcnew EventHandler( this, &MyDesigner::OnSecondItemSelected ) ) );
         }

         return m_Verbs;
      }
   }
   MyDesigner(){}

private:
   DesignerVerbCollection^ m_Verbs;
   void OnFirstItemSelected( Object^ /*sender*/, EventArgs^ /*args*/ )
   {
      // Display a message
      MessageBox::Show( "The first designer verb was invoked." );
   }

   void OnSecondItemSelected( Object^ /*sender*/, EventArgs^ /*args*/ )
   {
      // Display a message
      MessageBox::Show( "The second designer verb was invoked." );
   }
};

// Associate MyDesigner with this component type using a DesignerAttribute
[Designer(MyDesigner::typeid)]
public ref class Component1: public System::ComponentModel::Component{};

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft