OleMenuCommandService.GlobalInvoke Method (CommandID, Object)
Can be used to invoke any command within Visual Studio.
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)
Syntax
'Declaration
Public Overrides Function GlobalInvoke ( _
commandID As CommandID, _
arg As Object _
) As Boolean
public override bool GlobalInvoke(
CommandID commandID,
Object arg
)
public:
virtual bool GlobalInvoke(
CommandID^ commandID,
Object^ arg
) override
abstract GlobalInvoke :
commandID:CommandID *
arg:Object -> bool
override GlobalInvoke :
commandID:CommandID *
arg:Object -> bool
public override function GlobalInvoke(
commandID : CommandID,
arg : Object
) : boolean
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.
Remarks
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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.