OleMenuCommandService::GlobalInvoke Method (CommandID^, Object^)

Visual Studio 2015
 

Can be used to invoke any command within Visual Studio.

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

C#
C++
F#
VB
Copy 
public:
virtual bool GlobalInvoke(
	CommandID^ commandID,
	Object^ arg
) override

Parameters

commandID
Type: System.ComponentModel.Design::CommandID^

The command ID of the command to search for and execute.

arg
Type: System::Object^

The optional command argument.

Return Value

Type: System::Boolean

true if the invocation succeeded; otherwise, false.

Visual Studio uses a built-in search hierarchy to search for the requested command. The search pattern favors the current document window and then moves out to broader focus.

Some commands may take optional arguments, and they can be passed to the handler of the command via the arg parameter of GlobalInvoke. For instance, a Find command may accept a string representing the text to find. An OpenFile command may take a file name as an argument. If a command can use an optional argument, it defines what is expected and should document how one would invoke the command with optional arguments.

Return to top
Show: