OleMenuCommandService Class

This class derives from the MenuCommandService class and implements IOleCommandTarget. MenuCommandService is the managed class used to add handlers for menu commands and to define verbs.

This API is not CLS-compliant. 

Inheritance Hierarchy


Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)


<CLSCompliantAttribute(False)> _
<ComVisibleAttribute(True)> _
Public Class OleMenuCommandService _
    Inherits MenuCommandService _
    Implements IOleCommandTarget
public class OleMenuCommandService : MenuCommandService, 
public ref class OleMenuCommandService : public MenuCommandService, 
type OleMenuCommandService =  
        inherit MenuCommandService
        interface IOleCommandTarget
public class OleMenuCommandService extends MenuCommandService implements IOleCommandTarget

The OleMenuCommandService type exposes the following members.


  Name Description
Public method OleMenuCommandService(IServiceProvider) Creates a new menu command service.
Public method OleMenuCommandService(IServiceProvider, IOleCommandTarget) Creates a new menu command service.



  Name Description
Public property ParentTarget Gets or sets the parent command target.
Protected property ServiceProvider Obsolete. Gets the service provider.
Public property Verbs Gets a collection of the designer verbs that are currently available. (Inherited from MenuCommandService.)



  Name Description
Public method AddCommand Adds a command handler to the menu command service. (Inherited from MenuCommandService.)
Public method AddVerb Adds a verb to the verb table of the MenuCommandService. (Inherited from MenuCommandService.)
Public method Dispose() Releases all resources used by the MenuCommandService. (Inherited from MenuCommandService.)
Protected method Dispose(Boolean) Releases all resources used by the MenuCommandService. (Inherited from MenuCommandService.)
Protected method EnsureVerbs Ensures that the verb list has been created. (Inherited from MenuCommandService.)
Public method Equals 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 FindCommand(CommandID) Searches for the MenuCommand associated with the given command ID. (Inherited from MenuCommandService.)
Protected method FindCommand(Guid, Int32) Searches for the MenuCommand associated with the given command. (Inherited from MenuCommandService.)
Protected method GetCommandList Gets the command list for a given GUID. (Inherited from MenuCommandService.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetService Gets a reference to the requested service. (Inherited from MenuCommandService.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GlobalInvoke(CommandID) Can be used to invoke any command within Visual Studio. (Overrides MenuCommandService.GlobalInvoke(CommandID).)
Public method GlobalInvoke(CommandID, Object) Can be used to invoke any command within Visual Studio. (Overrides MenuCommandService.GlobalInvoke(CommandID, Object).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnCommandsChanged Called by a menu command when its status has changed. (Overrides MenuCommandService.OnCommandsChanged(MenuCommandsChangedEventArgs).)
Public method RemoveCommand Removes the given menu command from the document. (Inherited from MenuCommandService.)
Public method RemoveVerb Removes the given verb from the document. (Inherited from MenuCommandService.)
Public method ShowContextMenu Shows the shortcut menu with the given command ID at the given location. (Overrides MenuCommandService.ShowContextMenu(CommandID, Int32, Int32).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)



  Name Description
Public event MenuCommandsChanged Occurs when the status of a menu command has changed. (Inherited from MenuCommandService.)


Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IOleCommandTarget.Exec Infrastructure. Executes the selected command.
Explicit interface implemetationPrivate method IOleCommandTarget.QueryStatus Infrastructure. Sets command status.



OleMenuCommandService is automatically offered by the Package class (to offer global commands for an entire package), and it is also offered by the WindowPane class (to offer commands for the current window). This offering is always done via the service container, so anyone deriving from the Package or WindowPane classes can remove or replace the default implementation of this class. This class uses several other services. All of these services are optional, so the class's behavior will degrade if one or more services are missing. The following table shows which services are used and for what purpose:




Used to discover the current selection in order to obtain verbs offered by the currently selected designer.


Used to obtain the designer for the currently selected component, if any.


Used to notify Visual Studio that the command status has changed.

Used to execute global commands


Used to show context menus

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


Microsoft.VisualStudio.Shell Namespace