AsyncPackage Classe

Definição

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::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::Interop::IAsyncLoadablePackageInitialize, Microsoft::VisualStudio::Shell::Interop::IAsyncServiceProvider
public ref class AsyncPackage abstract : Microsoft::VisualStudio::Shell::Package, Microsoft::VisualStudio::Shell::IAsyncServiceContainer, 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]
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.IAsyncServiceProvider, Microsoft.VisualStudio.Shell.Interop.IAsyncLoadablePackageInitialize, Microsoft.VisualStudio.Shell.Interop.IAsyncServiceProvider
[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.IAsyncLoadablePackageInitialize, Microsoft.VisualStudio.Shell.Interop.IAsyncServiceProvider, 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 IAsyncServiceProvider
    interface IAsyncServiceContainer
[<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, IAsyncServiceProvider
Public MustInherit Class AsyncPackage
Inherits Package
Implements IAsyncLoadablePackageInitialize, IAsyncServiceContainer, IAsyncServiceProvider, IAsyncServiceProvider2, IVsAsyncToolWindowFactory, IVsAsyncToolWindowFactoryProvider
Herança
AsyncPackage
Derivado
Atributos
Implementações

Construtores

AsyncPackage()

Construtor padrão AsyncPackage.

Propriedades

ApplicationRegistryRoot

Obtém a chave do registro raiz do hive do registro do Visual Studio atual.

(Herdado de Package)
DisposalToken

Expõe um CancellationToken que pode ser usado para verificar se o pacote foi Descartado. Isso pode ocorrer para tarefas assíncronas que estão sendo executadas em um thread em segundo plano quando o Visual Studio começou a desligar. Use ShutdownToken para uma indicação anterior que o vs está desligando.

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 na lista de chaves de opção.

(Herdado de Package)
AddService(Type, AsyncServiceCreatorCallback)

Adiciona um serviço assíncrono a este pacote. Este serviço não será visível fora deste pacote.

AddService(Type, AsyncServiceCreatorCallback, Boolean)

Adiciona um serviço assíncrono a este pacote. Esse serviço pode ou não estar visível fora deste pacote, dependendo do valor de promote .

AddService(Type, AsyncServiceCreatorWithProgressCallback)

Adiciona um serviço assíncrono a este pacote que dá suporte a atualizações de progresso durante a inicialização. Este serviço não será visível fora deste pacote.

AddService(Type, AsyncServiceCreatorWithProgressCallback, Boolean)

Adiciona um serviço assíncrono a este pacote que dá suporte a atualizações de progresso durante a inicialização. Esse serviço pode ou não estar visível fora deste 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 ferramentas do tipo especificado com a ID especificada.

(Herdado de Package)
CreateToolWindow(Type, Int32)

Cria uma janela de ferramentas do tipo especificado com a ID especificada.

(Herdado de Package)
CreateToolWindow(Type, Int32, Object)

Cria uma janela de ferramenta do tipo especificado com a ID especificada.

(Herdado de Package)
CreateToolWindow(Type, Int32, UInt32)

Cria uma janela de ferramentas do tipo especificado com a ID especificada.

(Herdado de Package)
CreateToolWindow(Type, Int32, UInt32, Object, Guid)

Cria uma janela de ferramenta 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 ferramentas 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 não existir, ele criará e retornará um se create for true ou retornará NULL 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 instruído a 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 não existir, ele criará e retornará um se create for true ou retornará NULL se create for false.

GetAsyncToolWindowFactory(Guid)

Retorna a interface de fábrica da janela de ferramentas assíncrona para a janela de ferramentas identificada pelo toolWindowType , se houver suporte para a criação assíncrona na janela de ferramentas. Se a criação assíncrona não for suportada, NULL 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 este 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 confirme que as exceções podem não ter que ser assimiladas. Ele não garante que as exceções serão lançadas no entanto para casos de falha.

GetToolboxItemData(String, DataFormats+Format)

Obtém o conteúdo do formato de dados para a ID de item da caixa de ferramentas e o formato de dados especificados.

(Herdado de Package)
GetToolboxItemDataAsync(String, DataFormats+Format) (Herdado de Package)
GetToolWindowTitle(Type, Int32)

Retorna a cadeia de caracteres de título a ser usada para a janela de ferramentas. Se NULL for retornado, o nome do tipo da janela de ferramentas será usado para o título.

Initialize()

Lacrar este 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 iria, logicamente, supor que a inicialização acontece em um thread b/g, eles podem fazer coisas caras (síncronas) dentro de sua substituição, derrotando parte do benefício de cargas assíncronas. Para ajudar a levá-los de que iremos lacrar e, portanto, tudo o que eles podem substituir é a inicialização assíncrona, que é chamada 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 na preparação para criar a janela de ferramentas identificada pelo toolWindowType .

InstantiateToolWindow(Type) (Herdado de Package)
InstantiateToolWindow(Type, Object)

Construir uma janela de ferramentas 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 sejam estritamente uma parte da carga do pacote que pertenceria InitializeAsync(CancellationToken, IProgress<ServiceProgressData>) , mas isso deve acontecer logo após a carga do pacote (por exemplo, atualizar o status do comando).

OnLoadOptions(String, Stream)

Invocado pela classe de pacote quando há opções a serem lidas 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 solicitar o pacote se o Shell puder ser fechado.

(Herdado de Package)
RegisterEditorFactory(IVsEditorFactory)

Registra uma fábrica de editor 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 este pacote.

RemoveService(Type, Boolean)

Remove um serviço assíncrono registrado com este pacote.

ShowOptionPage(Type)

Exibe uma página de opções de ferramentas especificadas.

(Herdado de Package)
ShowToolWindowAsync(Type, Int32, Boolean, CancellationToken)

Exibe de forma assíncrona a janela da ferramenta correspondente ao tipo e à ID especificados. Se não existir, ele criará e retornará um se create for true ou retornará NULL 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 que é oferecido por este pacote.

IOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)

Executa um comando especificado ou exibe a 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 fornecido ao contêiner de serviço do VSPackage.

(Herdado de Package)
IServiceContainer.AddService(Type, Object, Boolean)

Adiciona o serviço fornecido ao contêiner de serviço do VSPackage.

(Herdado de Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback)

Adiciona o serviço fornecido ao contêiner de serviço do VSPackage.

(Herdado de Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback, Boolean)

Adiciona o serviço fornecido 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 os 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 de IServiceProvider interno.

(Herdado de Package)
IVsAsyncToolWindowFactory.CreateToolWindow(Guid, UInt32, Object)

Cria uma janela de ferramentas 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 NULL for retornado, o nome do tipo da janela de ferramentas será usado para o título.

IVsAsyncToolWindowFactory.InitializeToolWindowAsync(Guid, UInt32)

Executa a inicialização na preparação para criar a janela de ferramentas identificada pelo toolWindowType .

IVsPackage.Close()

Fecha e descarta o pacote.

(Herdado de Package)
IVsPackage.GetAutomationObject(String, Object)

Obtém um objeto amigável para automação para este pacote.

(Herdado de Package)
IVsPackage.GetPropertyPage(Guid, VSPROPSHEETPAGE[])

Proffers o 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 as opções do 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) (Herdado de Package)
IVsToolWindowFactory.CreateToolWindow(Guid, UInt32)

Cria uma janela de ferramentas 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 de 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>>)

Proffers um serviço implementado pelo tipo especificado para um contêiner de serviço assíncrono. Quando o serviço for consultado na primeira vez, a creator função será chamada. O serviço proffered será promovido para o contêiner de serviço assíncrono pai.

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>, Boolean)

Proffers um serviço implementado pelo tipo especificado para um contêiner de serviço assíncrono. Quando o serviço for consultado na primeira vez, a creator função será chamada.

ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>)

Proffers um serviço implementado pelo tipo especificado para um contêiner de serviço assíncrono. Quando o serviço for consultado na primeira vez, a creator função será chamada. O serviço proffered será promovido para o contêiner de serviço assíncrono pai.

ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>, Boolean)

Proffers um serviço implementado pelo tipo especificado para um contêiner de serviço assíncrono. Quando o serviço for consultado na 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 tipo 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.

Aplica-se a