Skip to content

Delete unnecessary spaces #2473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 13, 2019
Merged

Delete unnecessary spaces #2473

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 68 additions & 68 deletions docs/extensibility/changing-the-text-of-a-menu-command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,81 +2,81 @@
title: "Changing the Text of a Menu Command | Microsoft Docs"
ms.date: "11/04/2016"
ms.topic: "conceptual"
helpviewer_keywords:
helpviewer_keywords:
- "menus, changing text"
- "text, menus"
- "commands, changing text"
ms.assetid: 5cb676a0-c6e2-47e5-bd2b-133dc8842e46
author: "gregvanl"
ms.author: "gregvanl"
manager: jillfra
ms.workload:
ms.workload:
- "vssdk"
---
# Change the text of a menu command
The following steps show how to change the text label of a menu command by using the <xref:System.ComponentModel.Design.IMenuCommandService> service.
## Changing a menu command label with the IMenuCommandService
1. Create a VSIX project named `MenuText` with a menu command named **ChangeMenuText**. For more information, see [Create an extension with a menu command](../extensibility/creating-an-extension-with-a-menu-command.md).
2. In the *.vsct* file, add the `TextChanges` flag to your menu command, as shown in the following example.
```xml
<Button guid="guidChangeMenuTextPackageCmdSet" id="ChangeMenuTextId" priority="0x0100" type="Button">
<Parent guid="guidChangeMenuTextPackageCmdSet" id="MyMenuGroup" />
<Icon guid="guidImages" id="bmpPic1" />
<CommandFlag>TextChanges</CommandFlag>
<Strings>
<ButtonText>Invoke ChangeMenuText</ButtonText>
</Strings>
</Button>
```
3. In the *ChangeMenuText.cs* file, create an event handler that will be called before the menu command is displayed.
```csharp
private void OnBeforeQueryStatus(object sender, EventArgs e)
{
var myCommand = sender as OleMenuCommand;
if (null != myCommand)
{
myCommand.Text = "New Text";
}
}
```
You can also update the status of the menu command in this method by changing the <xref:System.ComponentModel.Design.MenuCommand.Visible%2A>, <xref:System.ComponentModel.Design.MenuCommand.Checked%2A>, and <xref:System.ComponentModel.Design.MenuCommand.Enabled%2A> properties on the <xref:Microsoft.VisualStudio.Shell.OleMenuCommand> object.
4. In the ChangeMenuText constructor, replace the original command initialization and placement code with code that creates a <xref:Microsoft.VisualStudio.Shell.OleMenuCommand> (rather than a `MenuCommand`) that represents the menu command, adds the <xref:Microsoft.VisualStudio.Shell.OleMenuCommand.BeforeQueryStatus> event handler, and gives the menu command to the menu command service.
Here is what it should look like:
```csharp
private ChangeMenuText(Package package)
{
if (package == null)
{
throw new ArgumentNullException(nameof(package));
}
this.package = package;
OleMenuCommandService commandService = this.ServiceProvider.GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
if (commandService != null)
{
CommandID menuCommandID = new CommandID(MenuGroup, CommandId);
EventHandler eventHandler = this.ShowMessageBox;
OleMenuCommand menuItem = new OleMenuCommand(ShowMessageBox, menuCommandID);
menuItem.BeforeQueryStatus +=
new EventHandler(OnBeforeQueryStatus);
commandService.AddCommand(menuItem);
}
}
```
5. Build the project and start debugging. The experimental instance of Visual Studio appears.
6. On the **Tools** menu you should see a command named **Invoke ChangeMenuText**.
7. Click the command. You should see the message box announcing that **MenuItemCallback** has been called. When you dismiss the message box, you should see that the name of the command on the Tools menu is now **New Text**.
The following steps show how to change the text label of a menu command by using the <xref:System.ComponentModel.Design.IMenuCommandService> service.

## Changing a menu command label with the IMenuCommandService

1. Create a VSIX project named `MenuText` with a menu command named **ChangeMenuText**. For more information, see [Create an extension with a menu command](../extensibility/creating-an-extension-with-a-menu-command.md).

2. In the *.vsct* file, add the `TextChanges` flag to your menu command, as shown in the following example.

```xml
<Button guid="guidChangeMenuTextPackageCmdSet" id="ChangeMenuTextId" priority="0x0100" type="Button">
<Parent guid="guidChangeMenuTextPackageCmdSet" id="MyMenuGroup" />
<Icon guid="guidImages" id="bmpPic1" />
<CommandFlag>TextChanges</CommandFlag>
<Strings>
<ButtonText>Invoke ChangeMenuText</ButtonText>
</Strings>
</Button>
```

3. In the *ChangeMenuText.cs* file, create an event handler that will be called before the menu command is displayed.

```csharp
private void OnBeforeQueryStatus(object sender, EventArgs e)
{
var myCommand = sender as OleMenuCommand;
if (null != myCommand)
{
myCommand.Text = "New Text";
}
}
```

You can also update the status of the menu command in this method by changing the <xref:System.ComponentModel.Design.MenuCommand.Visible%2A>, <xref:System.ComponentModel.Design.MenuCommand.Checked%2A>, and <xref:System.ComponentModel.Design.MenuCommand.Enabled%2A> properties on the <xref:Microsoft.VisualStudio.Shell.OleMenuCommand> object.

4. In the ChangeMenuText constructor, replace the original command initialization and placement code with code that creates a <xref:Microsoft.VisualStudio.Shell.OleMenuCommand> (rather than a `MenuCommand`) that represents the menu command, adds the <xref:Microsoft.VisualStudio.Shell.OleMenuCommand.BeforeQueryStatus> event handler, and gives the menu command to the menu command service.

Here is what it should look like:

```csharp
private ChangeMenuText(Package package)
{
if (package == null)
{
throw new ArgumentNullException(nameof(package));
}

this.package = package;

OleMenuCommandService commandService = this.ServiceProvider.GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
if (commandService != null)
{
CommandID menuCommandID = new CommandID(MenuGroup, CommandId);
EventHandler eventHandler = this.ShowMessageBox;
OleMenuCommand menuItem = new OleMenuCommand(ShowMessageBox, menuCommandID);
menuItem.BeforeQueryStatus +=
new EventHandler(OnBeforeQueryStatus);
commandService.AddCommand(menuItem);
}
}
```

5. Build the project and start debugging. The experimental instance of Visual Studio appears.

6. On the **Tools** menu you should see a command named **Invoke ChangeMenuText**.

7. Click the command. You should see the message box announcing that **MenuItemCallback** has been called. When you dismiss the message box, you should see that the name of the command on the Tools menu is now **New Text**.