AsyncPackage Classe

Definição

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Pacote:

Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Representa um VSPackage que pode lidar com serviços assíncronos.

public ref class AsyncPackage abstract : Microsoft::VisualStudio::Shell::Package, Microsoft::VisualStudio::Shell::IAsyncServiceContainer, Microsoft::VisualStudio::Shell::IAsyncServiceProvider2, Microsoft::VisualStudio::Shell::Interop::COMAsyncServiceProvider::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::Interop::IAsyncLoadablePackageInitialize, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactory, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactoryProvider

[Windows::Foundation::Metadata::WebHostHidden]
public ref class AsyncPackage abstract : Microsoft::VisualStudio::Shell::Package, Microsoft::VisualStudio::Shell::IAsyncServiceContainer, Microsoft::VisualStudio::Shell::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::IAsyncServiceProvider2, Microsoft::VisualStudio::Shell::Interop::IAsyncLoadablePackageInitialize, Microsoft::VisualStudio::Shell::Interop::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactory, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactoryProvider

[Windows::Foundation::Metadata::WebHostHidden]
class AsyncPackage abstract : Microsoft::VisualStudio::Shell::Package, Microsoft::VisualStudio::Shell::IAsyncServiceContainer, Microsoft::VisualStudio::Shell::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::IAsyncServiceProvider2, Microsoft::VisualStudio::Shell::Interop::IAsyncLoadablePackageInitialize, Microsoft::VisualStudio::Shell::Interop::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactory, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactoryProvider

[System.Runtime.InteropServices.ComVisible(true)]
public abstract class AsyncPackage : Microsoft.VisualStudio.Shell.Package, Microsoft.VisualStudio.Shell.IAsyncServiceContainer, Microsoft.VisualStudio.Shell.IAsyncServiceProvider2, Microsoft.VisualStudio.Shell.Interop.COMAsyncServiceProvider.IAsyncServiceProvider, Microsoft.VisualStudio.Shell.Interop.IAsyncLoadablePackageInitialize, Microsoft.VisualStudio.Shell.Interop.IVsAsyncToolWindowFactory, Microsoft.VisualStudio.Shell.Interop.IVsAsyncToolWindowFactoryProvider

[<System.Runtime.InteropServices.ComVisible(true)>]
type AsyncPackage = class
    inherit Package
    interface IAsyncServiceProvider
    interface IAsyncLoadablePackageInitialize
    interface IAsyncServiceProvider2
    interface IAsyncServiceProvider
    interface IAsyncServiceContainer
    interface IVsAsyncToolWindowFactory
    interface IVsAsyncToolWindowFactoryProvider

Public MustInherit Class AsyncPackage
Inherits Package
Implements IAsyncLoadablePackageInitialize, IAsyncServiceContainer, IAsyncServiceProvider, IAsyncServiceProvider2, IVsAsyncToolWindowFactory, IVsAsyncToolWindowFactoryProvider

Herança

Object

Package

AsyncPackage

Derivado

Microsoft.VisualStudio.Modeling.Shell.AsyncModelingPackage

Microsoft.VisualStudio.Shell.ExtensionPointAsyncPackage

Atributos

ComVisibleAttribute

Implementações

IAsyncServiceContainer IAsyncServiceProvider IAsyncLoadablePackageInitialize IAsyncServiceProvider2 IVsAsyncToolWindowFactory IVsAsyncToolWindowFactoryProvider Microsoft.VisualStudio.Shell.Interop.COMAsyncServiceProvider.IAsyncServiceProvider

Construtores

AsyncPackage()

Construtor padrão AsyncPackage.

Propriedades

ApplicationRegistryRoot	Obtém a chave do registro raiz do hive atual do Registro do Visual Studio. (Herdado de Package)
DisposalToken	Expõe um CancellationToken que pode ser usado para marcar se o pacote tiver sido descartado. Isso pode acontecer para tarefas assíncronas que estão em execução em um thread em segundo plano quando o Visual Studio começou a ser desligado. Use ShutdownToken para uma indicação anterior de que o VS está sendo desligado.
JoinableTaskCollection	Obtém a coleção de tarefas assíncronas iniciadas por este pacote.
JoinableTaskFactory	Obtém a fábrica a ser usada para tarefas assíncronas iniciadas por este pacote.
UserDataPath	Obtém o caminho para o armazenamento de dados do usuário para o Visual Studio. (Herdado de Package)
UserLocalDataPath	Obtém o caminho para o armazenamento de dados do usuário local para o Visual Studio. (Herdado de Package)
UserRegistryRoot	Obtém uma chave do Registro que pode ser usada para armazenar dados do usuário. (Herdado de Package)
Zombied	Obtém um valor que indica se o pacote no processo de desligamento. (Herdado de Package)

Métodos

AddOptionKey(String)	Adiciona um nome de chave de opção de usuário à lista de chaves de opção. (Herdado de Package)
AddService(Type, AsyncServiceCreatorCallback)	Adiciona um serviço assíncrono a esse pacote. Esse serviço não ficará visível fora desse pacote.
AddService(Type, AsyncServiceCreatorCallback, Boolean)	Adiciona um serviço assíncrono a esse pacote. Esse serviço pode ou não estar visível fora desse pacote, dependendo do valor de promote.
AddService(Type, AsyncServiceCreatorWithProgressCallback)	Adiciona um serviço assíncrono a esse pacote que dá suporte a atualizações de progresso durante a inicialização. Esse serviço não ficará visível fora desse pacote.
AddService(Type, AsyncServiceCreatorWithProgressCallback, Boolean)	Adiciona um serviço assíncrono a esse pacote que dá suporte a atualizações de progresso durante a inicialização. Esse serviço pode ou não estar visível fora desse pacote, dependendo do valor de promote.
CreateInstance(Guid, Guid, Type)	Cria o objeto COM especificado usando o objeto CLSID do registro local do Visual Studio. (Herdado de Package)
CreateTool(Guid)	Permite que classes derivadas forneçam uma implementação, se necessário. (Herdado de Package)
CreateToolWindow(Guid, Int32)	Cria uma janela de ferramenta do tipo especificado com a ID especificada. (Herdado de Package)
CreateToolWindow(Type, Int32)	Cria uma janela de ferramenta do tipo especificado com a ID especificada. (Herdado de Package)
CreateToolWindow(Type, Int32, Object)	Create uma janela de ferramentas do tipo especificado com a ID especificada. (Herdado de Package)
CreateToolWindow(Type, Int32, UInt32)	Cria uma janela de ferramenta do tipo especificado com a ID especificada. (Herdado de Package)
CreateToolWindow(Type, Int32, UInt32, Object, Guid)	Create uma janela de ferramentas do tipo especificado com a ID especificada. Esse é o único método que deve chamar IVsUiShell.CreateToolWindow() (Herdado de Package)
Dispose(Boolean)	Descarta o objeto e o token de cancelamento associado.
FindToolWindow(Type, Int32, Boolean)	Obtém a janela de ferramenta correspondente ao tipo e à ID especificados. (Herdado de Package)
FindToolWindowAsync(Type, Int32, Boolean, CancellationToken)	Localiza de forma assíncrona a janela de ferramentas correspondente ao tipo e à ID especificados. Se ele não existir, ele criará e retornará um se create for verdadeiro ou retornará nulo se create for false.
FindWindowPane(Type, Int32, Boolean)	Obtém o painel de janela correspondente ao tipo e à ID especificados e, se nenhum painel de janela desse tipo existir, criará um se for dito para fazê-lo. (Herdado de Package)
FindWindowPaneAsync(Type, Int32, Boolean, CancellationToken)	Localiza de forma assíncrona o painel de janela correspondente ao tipo e à ID especificados. Se ele não existir, ele criará e retornará um se create for verdadeiro ou retornará nulo se create for false.
GetAsyncToolWindowFactory(Guid)	Retorna a interface de fábrica de janelas de ferramentas assíncrona para a janela de ferramenta identificada por toolWindowType, se houver suporte para a criação assíncrona para a janela de ferramentas. Se não houver suporte para a criação assíncrona, nulo será retornado.
GetAutomationObject(String)	Obtém o objeto de automação para o VSPackage. (Herdado de Package)
GetDialogPage(Type)	Obtém a página de diálogo solicitada. (Herdado de Package)
GetOutputPane(Guid, String)	Obtém a janela de saída solicitada. (Herdado de Package)
GetProviderLocale()	Retorna a localidade associada a esse provedor de serviços. (Herdado de Package)
GetService(Type)	Recupera um serviço registrado com este pacote. Esse método é síncrono e até mesmo os serviços assíncronos recuperados dessa maneira serão recuperados de forma síncrona.
GetServiceAsync(Type)	Recupera um serviço assíncrono.
GetServiceAsync(Type, Boolean)	Recupera um serviço assíncrono, mas permite que o chamador indira que as exceções podem não ter que ser engolidas. No entanto, não garante que exceções sejam geradas para casos de falha.
GetToolboxItemData(String, DataFormats+Format)	Obtém o conteúdo do formato de dados para a ID e o formato de dados do item da caixa de ferramentas especificados. (Herdado de Package)
GetToolboxItemDataAsync(String, DataFormats+Format)	Representa um VSPackage que pode lidar com serviços assíncronos. (Herdado de Package)
GetToolWindowTitle(Type, Int32)	Retorna a cadeia de caracteres de título a ser usada para a janela de ferramentas. Se nulo for retornado, o nome do tipo da janela de ferramentas será usado para o título.
Initialize()	Selo esse método. Devido a um risco quase inevitável de deadlock, SetSite (que é o que chama Initialize) ainda ocorre no thread da interface do usuário mesmo para o pacote assíncrono. Como a maioria dos autores de pacotes assíncronos assumiria, logicamente, que Inicializar ocorre em um thread b/g, eles podem fazer coisas caras (síncronas) dentro de sua substituição, derrotando alguns dos benefícios das cargas assíncronas. Para ajudar a afastá-los disso, vamos lacre-lo e, portanto, tudo o que eles podem substituir é inicializar assíncrono, que é chamado no thread b/g.
InitializeAsync(CancellationToken, IProgress<ServiceProgressData>)	A parte de inicialização assíncrona do processo de inicialização do pacote. Esse método é invocado de um thread em segundo plano.
InitializeToolWindowAsync(Type, Int32, CancellationToken)	Executa a inicialização em preparação para criar a janela de ferramenta identificada por toolWindowType.
InstantiateToolWindow(Type)	Representa um VSPackage que pode lidar com serviços assíncronos. (Herdado de Package)
InstantiateToolWindow(Type, Object)	Construa uma janela de ferramenta do tipo especificado. (Herdado de Package)
IsLocalService(Type)	Determina se o tipo de serviço especificado pode ser recuperado sem a necessidade de uma transição RPC para o thread da interface do usuário. (Herdado de Package)
OnAfterPackageLoadedAsync(CancellationToken)	Quando substituído por um tipo derivado, pode iniciar operações com efeitos colaterais que não são estritamente uma parte da carga do pacote que pertenceria, InitializeAsync(CancellationToken, IProgress<ServiceProgressData>) mas que deve acontecer logo após o carregamento do pacote (por exemplo, atualizar o comando status).
OnLoadOptions(String, Stream)	Invocado pela classe de pacote quando há opções a serem lidas fora do arquivo de solução. (Herdado de Package)
OnSaveOptions(String, Stream)	Invocado pela Package classe quando há opções a serem salvas no arquivo de solução. (Herdado de Package)
ParseToolboxResource(TextReader, Guid)	Analisa um recurso de texto inserido do formato apropriado para obter informações sobre quais itens devem ser adicionados à Caixa de Ferramentas. (Herdado de Package)
ParseToolboxResource(TextReader, ResourceManager)	Analisa um recurso de texto inserido do formato apropriado para obter informações sobre quais itens devem ser adicionados à Caixa de Ferramentas. (Herdado de Package)
QueryClose(Boolean)	Chamado para perguntar ao pacote se o shell pode ser fechado. (Herdado de Package)
RegisterEditorFactory(IVsEditorFactory)	Registra uma fábrica de editores com o Visual Studio. (Herdado de Package)
RegisterProjectFactory(IVsProjectFactory)	Registra uma fábrica de projetos com o Visual Studio. (Herdado de Package)
RemoveService(Type)	Remove um serviço assíncrono registrado com esse pacote.
RemoveService(Type, Boolean)	Remove um serviço assíncrono registrado com esse pacote.
ShowOptionPage(Type)	Exibe uma página de opções de ferramentas especificadas. (Herdado de Package)
ShowToolWindowAsync(Type, Int32, Boolean, CancellationToken)	Mostra de forma assíncrona a janela de ferramenta correspondente ao tipo e à ID especificados. Se ele não existir, ele criará e retornará um se create for verdadeiro ou retornará nulo se create for false.

Eventos

ToolboxInitialized	Evento gerado sempre que o Visual Studio inicializa sua Caixa de Ferramentas. (Herdado de Package)
ToolboxUpgraded	Evento gerado sempre que o Visual Studio atualiza sua Caixa de Ferramentas. (Herdado de Package)

Implantações explícitas de interface

IAsyncLoadablePackageInitialize.Initialize(IAsyncServiceProvider, IProfferAsyncService, IAsyncProgressCallback)	Versão assíncrona do SetSite, chamada de um thread b/g.
IAsyncServiceProvider.QueryServiceAsync(Guid)	Obtenha um serviço de inicialização assíncrona oferecido por esse pacote.
IOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)	Executa um comando especificado ou exibe ajuda para um comando. (Herdado de Package)
IOleCommandTarget.QueryStatus(Guid, UInt32, OLECMD[], IntPtr)	Consulta o objeto para saber o status de um ou mais comandos gerados pelos eventos da interface do usuário. (Herdado de Package)
IServiceContainer.AddService(Type, Object)	Adiciona o serviço especificado ao contêiner de serviço do VSPackage. (Herdado de Package)
IServiceContainer.AddService(Type, Object, Boolean)	Adiciona o serviço especificado ao contêiner de serviço do VSPackage. (Herdado de Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback)	Adiciona o serviço especificado ao contêiner de serviço do VSPackage. (Herdado de Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback, Boolean)	Adiciona o serviço determinado ao contêiner de serviço por meio do especificado ServiceCreatorCallback. (Herdado de Package)
IServiceContainer.RemoveService(Type)	Remove o tipo de serviço fornecido do contêiner de serviço. (Herdado de Package)
IServiceContainer.RemoveService(Type, Boolean)	Remove o tipo de serviço fornecido do contêiner de serviço e, opcionalmente, promove a remoção do serviço para contêineres de serviço pai. (Herdado de Package)
IServiceProvider.GetService(Type)	Obtém o serviço do tipo especificado. (Herdado de Package)
IServiceProvider.QueryService(Guid, Guid, IntPtr)	Implementação interna do IServiceProvider. (Herdado de Package)
IVsAsyncToolWindowFactory.CreateToolWindow(Guid, UInt32, Object)	Cria uma janela de ferramenta do tipo especificado com a ID especificada.
IVsAsyncToolWindowFactory.GetToolWindowTitle(Guid, UInt32)	Retorna a cadeia de caracteres de título a ser usada para a janela de ferramentas. Se nulo for retornado, o nome do tipo da janela de ferramentas será usado para o título.
IVsAsyncToolWindowFactory.InitializeToolWindowAsync(Guid, UInt32)	Executa a inicialização em preparação para criar a janela de ferramenta identificada por toolWindowType.
IVsPackage.Close()	Fecha e descarta o pacote. (Herdado de Package)
IVsPackage.GetAutomationObject(String, Object)	Obtém um objeto amigável à automação para este pacote. (Herdado de Package)
IVsPackage.GetPropertyPage(Guid, VSPROPSHEETPAGE[])	Oferece acesso às Opções do menu Ferramentas e às páginas de propriedades das caixas de diálogo Personalizar Caixa de Ferramentas. (Herdado de Package)
IVsPackage.QueryClose(Int32)	Chamado para perguntar ao VSPackage se o shell do Visual Studio pode ser fechado. (Herdado de Package)
IVsPackage.ResetDefaults(UInt32)	Redefine os padrões da Caixa de Ferramentas. (Herdado de Package)
IVsPackage.SetSite(IServiceProvider)	Inicializa o VSPackage no ambiente do Visual Studio. (Herdado de Package)
IVsPersistSolutionOpts.LoadUserOptions(IVsSolutionPersistence, UInt32)	Carrega opções de usuário para uma determinada solução. (Herdado de Package)
IVsPersistSolutionOpts.ReadUserOptions(IStream, String)	Lê as opções do usuário para uma determinada solução. (Herdado de Package)
IVsPersistSolutionOpts.SaveUserOptions(IVsSolutionPersistence)	Salva as opções do usuário para uma determinada solução. (Herdado de Package)
IVsPersistSolutionOpts.WriteUserOptions(IStream, String)	Grava opções de usuário para uma determinada solução. (Herdado de Package)
IVsToolboxItemProvider.GetItemContent(String, UInt16, IntPtr)	Obtém um item. (Herdado de Package)
IVsToolboxItemProvider2.GetItemContentAsync(String, UInt16)	Representa um VSPackage que pode lidar com serviços assíncronos. (Herdado de Package)
IVsToolWindowFactory.CreateToolWindow(Guid, UInt32)	Cria uma janela de ferramenta do tipo especificado com a ID especificada. (Herdado de Package)
IVsUserSettings.ExportSettings(String, IVsSettingsWriter)	Esse método implementa a IVsUserSettings Interface usada para gerenciar perfis e configurações de importação/exportação para arquivos XML. (Herdado de Package)
IVsUserSettings.ImportSettings(String, IVsSettingsReader, UInt32, Int32)	Recupera a configuração de um VSPackage usando o mecanismo de configurações do Visual Studio quando um usuário seleciona a opção de importação do recurso Configurações de Importação/Exportação no menu Ferramentas do IDE. Esse método faz parte da implementação da IVsUserSettings interface usada para gerenciar perfis e importar/exportar configurações para arquivos XML. (Herdado de Package)
IVsUserSettingsMigration.MigrateSettings(IVsSettingsReader, IVsSettingsWriter, String)	Migra as configurações de uma versão anterior. (Herdado de Package)
IVsUserSettingsQuery.NeedExport(String, Int32)	Determina se as configurações foram alteradas e devem ser exportadas novamente. (Herdado de Package)

Métodos de Extensão

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>)	Oferece um serviço implementado pelo tipo especificado para um contêiner de serviço assíncrono. Quando o serviço for consultado pela primeira vez, a creator função será chamada. O serviço oferecido será promovido para o contêiner de serviço assíncrono pai.
ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>, Boolean)	Oferece um serviço implementado pelo tipo especificado para um contêiner de serviço assíncrono. Quando o serviço for consultado pela primeira vez, a creator função será chamada.
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>)	Oferece um serviço implementado pelo tipo especificado para um contêiner de serviço assíncrono. Quando o serviço for consultado pela primeira vez, a creator função será chamada. O serviço oferecido será promovido para o contêiner de serviço assíncrono pai.
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>, Boolean)	Oferece um serviço implementado pelo tipo especificado para um contêiner de serviço assíncrono. Quando o serviço for consultado pela primeira vez, a creator função será chamada.
QueryService(IServiceProvider, Guid)	Obtém um serviço exposto por um provedor de serviços com base em seu GUID de serviço.
QueryService<TService>(IServiceProvider)	Obtém um serviço exposto por um provedor de serviços com base em seu tipo de serviço.
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider)	Obtém uma interface de serviço de um provedor de serviços de forma assíncrona.
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider, Boolean)	Obtém uma interface de serviço de um provedor de serviços de forma assíncrona.