Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Este documento é um início rápido que mostra como criar sua primeira extensão usando VisualStudio.Extensibility. A extensão é executada fora do processo, ou seja, fora do processo de Visual Studio.
Prerequisites
- Recomenda-se o Visual Studio 2026 versão 18.11 ou posterior com a carga de trabalho de desenvolvimento de extensões do Visual Studio. Para versões anteriores, VisualStudio.Extensibility requer Visual Studio 2022 versão 17.9 ou posterior.
Criar o projeto de extensão
Visual Studio 18.11 ou superior (recomendado)
Use o modelo de Project DO VSIX moderno e selecione VisualStudio.Extensibility (Out-Of-Process) em Tipo de Extensão. O modelo usa como padrão o VSSDK, portanto, selecione a opção fora do processo para este início rápido.
Siga Criar uma extensão com o modelo de Project VSIX moderno para as etapas do assistente e as opções de SDK do projeto.
Versões de Visual Studio anteriores
Use o modelo VisualStudio.Extensibility Project para criar um novo projeto de extensibilidade.
Neste ponto, você está pronto para começar a estender Visual Studio adicionando comandos e componentes do editor à sua extensão.
A classe Extensão
O modelo cria uma classe que herda de Extension ↗. Essa classe é a primeira que é instanciada quando sua extensão é carregada. No método InitializeServices ↗, você pode adicionar seus próprios serviços à coleção de serviços para disponibilizá-los para injeção de dependência.
[VisualStudioContribution]
internal class ExtensionEntrypoint : Extension
{
public override ExtensionConfiguration ExtensionConfiguration => new()
{
Metadata = new(
id: "MyExtension.abc123",
version: this.ExtensionAssemblyVersion,
publisherName: "My Company",
displayName: "My Extension"),
};
protected override void InitializeServices(IServiceCollection serviceCollection)
{
base.InitializeServices(serviceCollection);
// You can configure dependency injection here by adding services to the serviceCollection.
}
}
Você também pode ver o VisualStudioContribution ↗ atributo usado para marcar componentes de extensão que devem ser consumidos por Visual Studio. Esse atributo pode ser aplicado a classes que implementam IVisualStudioContributionClass ↗ ou propriedades estáticas de um tipo que está implementando IVisualStudioContributionProperty ↗.
Adicionar seu primeiro comando
O modelo cria Command1.cs como seu primeiro manipulador de comandos, que você pode usar como ponto de partida. Como queremos tornar o Visual Studio ciente desse comando e a classe Command ↗ implementa IVisualStudioContributionClass ↗, o comando é marcado com o atributo VisualStudioContribution.
[VisualStudioContribution]
internal class Command1 : Command
{
O comando tem uma propriedade de configuração chamada CommandConfiguration ↗ , que define seu nome de exibição, ícone e posicionamento no Extensions menu.
public override CommandConfiguration CommandConfiguration => new("%MyExtension.Command1.DisplayName%")
{
// Use this object initializer to set optional parameters for the command. The required parameter,
// displayName, is set above. DisplayName is localized and references an entry in .vsextension\string-resources.json.
Icon = new(ImageMoniker.KnownValues.Extension, IconSettings.IconAndText),
Placements = new[] { CommandPlacement.KnownPlacements.ExtensionsMenu },
};
As propriedades de configuração são avaliadas pelo compilador C# ao compilar a extensão e seus valores são salvos como metadados de extensão para que Visual Studio possam lê-la sem carregar o assembly de extensão. Por esse motivo, as propriedades de configuração têm restrições adicionais em comparação com propriedades normais (por exemplo, elas devem ser somente leitura).
Você pode ver que o nome de exibição do comando é "%MyExtension.Command1.DisplayName%", que faz referência à MyExtension.Command1.DisplayName cadeia de caracteres no .vsextension/string-resources.json arquivo, permitindo que essa cadeia de caracteres seja localizada.
Quando o comando é executado, o Visual Studio chama o método ExecuteCommandAsync ↗ no qual você pode colocar um ponto de interrupção. Você pode usar o argumento context ou this.Extensibility para interagir com o Visual Studio.
Por exemplo, um manipulador de comandos pode ser o seguinte:
public override async Task ExecuteCommandAsync(IClientContext context, CancellationToken cancellationToken)
{
await this.Extensibility.Shell().ShowPromptAsync(
"Hello from an extension!",
PromptOptions.OK,
cancellationToken);
}
Para obter mais informações sobre como adicionar comandos, consulte a seção Comandos .
Depurar sua extensão
Verifique se o projeto de extensão está selecionado como projeto de inicialização no Visual Studio e pressione
F5para iniciar a depuração.Pressionar
F5cria a extensão e a implanta na instância experimental da versão do Visual Studio que você está usando. O depurador deverá ser anexado depois que a extensão for carregada.Você pode encontrar o novo comando no
Extensionsmenu, conforme mostrado na imagem a seguir:
Próximas Etapas
- Adicionar um comando — o recurso inicial mais comum a ser desenvolvido
- Janelas de ferramentas — adicionar painéis personalizados da interface do usuário
- Anatomia de uma extensão – entenda a estrutura do projeto e os principais conceitos
- Ver todas as amostras ↗ — extensões completas e funcionais no GitHub