Поделиться через

Руководство. Создание первого расширения: Hello World

  • Статья

В этом примере Hello World описывается создание первого расширения для Visual Studio. В этом руководстве показано, как добавить новую команду в Visual Studio.

В процессе вы узнаете, как:

В этом примере вы используете Visual C# для добавления пользовательской кнопки меню с именем "Say Hello World!", которая выглядит следующим образом:

снимок экрана, показывающий команду настраиваемого меню.

Необходимые условия

Перед началом работы убедитесь, что вы установили рабочую нагрузку разработки расширений Visual Studio , которая включает шаблон VSIX и пример кода.

Заметка

Вы можете использовать любой выпуск Visual Studio (Community, Professional или Enterprise) для создания проекта расширяемости Visual Studio.

Создание проекта расширения

  1. В меню файла выберите Создать>Проект. Найдите vsix и выберите проект VSIX C#, а затем нажмите Далее.

  2. Введите "HelloWorld" для имени проекта и выберите Создать.

снимок экрана, показывающий создание нового проекта VSIX.

Теперь вы увидите проект «HelloWorld» в обозревателе решений.

Добавление настраиваемой команды

  1. Если выбрать файл манифеста .vsixmanifest, можно увидеть, какие параметры можно изменить, например описание, автор и версия.

  2. Щелкните правой кнопкой мыши на проекте, а не на решении. В контекстном меню выберите Добавить, а затем Новый элемент.

  3. Выберите раздел расширяемости, затем выберите команду .

  4. В поле Имя в нижней части введите имя файла, например Command.cs.

снимок экрана, показывающий создание настраиваемой команды.

Новый файл команды отображается в обозревателе решений. В узле ресурсов можно найти другие файлы, связанные с командой. Например, если вы хотите изменить изображение, файл PNG находится здесь.

Изменение исходного кода

На этом этапе текст команды и кнопки автоматически генерируются и не являются интересными. Вы можете изменить VSCT-файл и CS-файл, если вы хотите внести изменения.

  • VSCT-файл позволяет переименовать команды и определить, где они идут в командной системе Visual Studio. При изучении VSCT-файла обратите внимание на комментарии, объясняющие, что каждый раздел кода в файле VSCT контролирует.

  • CS-файл позволяет определить действия, такие как обработчик щелчка.

  1. В обозревателе решенийнайдите VSCT-файл для расширения VSPackage. В этом случае он называется HelloWorldPackage.vsct.

  2. Измените параметр ButtonText на Say Hello World!.

      ...
  <Button guid="guidCommandPackageCmdSet" id="CommandId" priority="0x0100" type="Button">
    <Parent guid="guidCommandPackageCmdSet" id="MyMenuGroup" />
    <Icon guid="guidImages" id="bmpPic1" />
    <Strings>
        <ButtonText>Say Hello World!</ButtonText>
    </Strings>
  </Button>
  ...

  3. Вернитесь к проводнику решений и найдите файл Command.cs. В методе Execute измените строку message с string.Format(..) на Hello World!.

      ...
  private void Execute(object sender, EventArgs e)
  {
    ThreadHelper.ThrowIfNotOnUIThread();
    string message = "Hello World!";
    string title = "Command";

    // Show a message box to prove we were here
    VsShellUtilities.ShowMessageBox(
        this.ServiceProvider,
        message,
        title,
        OLEMSGICON.OLEMSGICON_INFO,
        OLEMSGBUTTON.OLEMSGBUTTON_OK,
        OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST);
  }
  ...

Обязательно сохраните изменения в каждом файле.

Запустите его

Теперь можно запустить исходный код в экспериментальном экземпляре Visual Studio.

Шаг 1. Нажмите клавишу F5, чтобы запустить команду начать отладку. Эта команда создает ваш проект и запускает отладчик, открывая новый экземпляр Visual Studio, называемый Экспериментальный Экземпляр.

Шаг 2. В меню инструментов экспериментального экземпляращелкните Say Hello World!.

снимок экрана, показывающий, что пользовательская команда отображает окно сообщения.

Вы должны увидеть результат выполнения вашей новой пользовательской команды, в этом случае диалоговое окно в центре экрана, которое показывает вам сообщение Hello World!.

Дальнейшие действия

Теперь, когда вы знаете основы работы с расширяемостью Visual Studio, ознакомьтесь с дополнительными сведениями: