IMenuCommandService Interface

Reference

Definition

Namespace:: System.ComponentModel.Design

Assembly:: System.ComponentModel.TypeConverter.dll

Assembly:: System.dll

Assembly:: netstandard.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 methods to manage the global designer verbs and menu commands available in design mode, and to show some types of shortcut menus.

public interface class IMenuCommandService

public interface IMenuCommandService

[System.Runtime.InteropServices.ComVisible(true)]
public interface IMenuCommandService

type IMenuCommandService = interface

[<System.Runtime.InteropServices.ComVisible(true)>]
type IMenuCommandService = interface

Public Interface IMenuCommandService

Derived: System.ComponentModel.Design.MenuCommandService

Attributes: ComVisibleAttribute

Examples

This example demonstrates using the IMenuCommandService to add a MenuCommand.

   public ref class CDesigner: public ComponentDesigner
   {
   public:
    [PermissionSetAttribute(SecurityAction::Demand, Name="FullTrust")]
      virtual void Initialize( IComponent^ comp ) override
      {
         ComponentDesigner::Initialize( comp );
         IMenuCommandService^ mcs = static_cast<IMenuCommandService^>(comp->Site->GetService( IMenuCommandService::typeid ));
         MenuCommand^ mc = gcnew MenuCommand( gcnew EventHandler( this, &CDesigner::OnF1Help ),StandardCommands::F1Help );
         mc->Enabled = true;
         mc->Visible = true;
         mc->Supported = true;
         mcs->AddCommand( mc );
         System::Windows::Forms::MessageBox::Show( "Initialize() has been invoked." );
      }

   private:
      void OnF1Help( Object^ /*sender*/, EventArgs^ /*e*/ )
      {
         System::Windows::Forms::MessageBox::Show( "F1Help has been invoked." );
      }
   };
}

public class CDesigner : System.ComponentModel.Design.ComponentDesigner 
{
    public override void Initialize(IComponent comp) 
    {
        base.Initialize(comp);

        IMenuCommandService mcs = (IMenuCommandService)comp.Site.
                    GetService(typeof(IMenuCommandService));
        MenuCommand mc = new MenuCommand(new EventHandler(OnF1Help), StandardCommands.F1Help);
        mc.Enabled = true;
        mc.Visible = true;
        mc.Supported = true;
        mcs.AddCommand(mc);
        System.Windows.Forms.MessageBox.Show("Initialize() has been invoked.");
    }

    private void OnF1Help(object sender, EventArgs e) 
    {
        System.Windows.Forms.MessageBox.Show("F1Help has been invoked.");
    }
}

<System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
Public Class CDesigner
    Inherits System.ComponentModel.Design.ComponentDesigner

    Public Overrides Sub Initialize(ByVal comp As IComponent)
        MyBase.Initialize(comp)

        Dim mcs As IMenuCommandService = CType(comp.Site.GetService(GetType(IMenuCommandService)), IMenuCommandService)
        Dim mc As New MenuCommand(New EventHandler(AddressOf OnF1Help), StandardCommands.F1Help)
        mc.Enabled = True
        mc.Visible = True
        mc.Supported = True
        mcs.AddCommand(mc)
        System.Windows.Forms.MessageBox.Show("Initialize() has been invoked.")
    End Sub

    Private Sub OnF1Help(ByVal sender As Object, ByVal e As EventArgs)
        System.Windows.Forms.MessageBox.Show("F1Help has been invoked.")
    End Sub
End Class

Remarks

This interface provides methods to:

Find, invoke, add and remove global designer verb commands.
Find, invoke, add and remove standard menu commands.
Alter the event handlers associated with standard menu commands.
Display a shortcut menu of standard commands that is associated with a menu CommandID.

Designer verbs represent custom-defined commands that are listed on the shortcut menu in design mode. A designer verb can provide a specified text label. Each designer verb is automatically assigned a unique CommandID. A designer can provide designer verbs through its Verbs property, but these are only available when the designer's component is currently selected. Global designer verbs are designer verb commands that can be accessed from a design-mode shortcut menu regardless of the selected component. This interface allows you to manage the set of global designer verbs that are available in design mode.

You can add a global designer verb using the AddVerb method, and you can remove a global designer verb using the RemoveVerb method. You can invoke a designer verb using the GlobalInvoke method if you know the CommandID of the verb. The Verbs property of this interface contains the current set of designer verb commands to display in a shortcut menu. This set of designer verb commands consists of all global designer verbs and any designer verbs offered by the designer of any currently selected component. This set of verbs is updated each time a component with a designer offering designer verb commands is selected or deselected.

Menu commands are limited to the set of predefined standard commands. Most of the predefined standard commands are defined in the StandardCommands and MenuCommands enumerations. You can add, remove, and invoke menu commands, and search for menu commands that have been added to a menu using methods of this interface.

You can add a standard menu command using the AddCommand method, and remove a standard menu command using the RemoveCommand method. You can attach an event handler to a predefined standard menu command by following the procedure detailed in the documentation for the AddCommand method. You can retrieve a menu command by CommandID if it has been added to a menu using the FindCommand method. You can invoke a menu command or designer verb command by CommandID using the GlobalInvoke method.

Note

An attempt to add a menu command with an already existing CommandID will throw an InvalidOperationException. When adding a menu command, be sure to check that it is not already on a menu using the FindCommand method, or use exception handling wisely.

Note

A menu command can be added to a menu, and have its Visible or Enabled properties set to false. If you cannot visually locate a menu command that has been added on a menu, one of these properties may have been set to false.

You can show certain standard shortcut menus containing menu commands at a specified location using the ShowContextMenu method. The documentation for this method contains a table listing the command IDs that specify the valid menus to show.

Properties

Verbs

Gets a collection of the designer verbs that are currently available.

Methods

AddCommand(MenuCommand)	Adds the specified standard menu command to the menu.
AddVerb(DesignerVerb)	Adds the specified designer verb to the set of global designer verbs.
FindCommand(CommandID)	Searches for the specified command ID and returns the menu command associated with it.
GlobalInvoke(CommandID)	Invokes a menu or designer verb command matching the specified command ID.
RemoveCommand(MenuCommand)	Removes the specified standard menu command from the menu.
RemoveVerb(DesignerVerb)	Removes the specified designer verb from the collection of global designer verbs.
ShowContextMenu(CommandID, Int32, Int32)	Shows the specified shortcut menu at the specified location.

Applies to

Deila með