AsyncPackage Methods

Visual Studio 2015
 

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

NameDescription
System_CAPS_protmethodAddOptionKey(String^)

Adds a user option key name into the list of option keys.(Inherited from Package.)

System_CAPS_pubmethodAddService(Type^, AsyncServiceCreatorCallback^)

Adds an async service to this package. This service is no visible outside of this package.

System_CAPS_pubmethodAddService(Type^, AsyncServiceCreatorCallback^, Boolean)

Adds an async service to this package. This service may or may not be visible outside of this package, depending on the value of promote.

System_CAPS_pubmethodAddService(Type^, AsyncServiceCreatorWithProgressCallback^)

Adds an async service to this package. This service is not visible outside this package.

System_CAPS_pubmethodAddService(Type^, AsyncServiceCreatorWithProgressCallback^, Boolean)

Adds an async service to this package. This service may or may not be visible outside of this package, depending on the value of promote.

System_CAPS_pubmethodCreateInstance(Guid, Guid, Type^)

Creates the specified COM object using the Visual Studio's local registry CLSID object.(Inherited from Package.)

System_CAPS_pubmethodCreateTool(Guid)

Enables derived classes to provide an implementation if necessary.(Inherited from Package.)

System_CAPS_protmethodCreateToolWindow(Guid, Int32)

Creates a tool window of the specified type with the specified ID.(Inherited from Package.)

System_CAPS_protmethodCreateToolWindow(Type^, Int32)

Creates a tool window of the specified type with the specified ID.(Inherited from Package.)

System_CAPS_protmethodCreateToolWindow(Type^, Int32, UInt32)

Creates a tool window of the specified type with the specified ID.(Inherited from Package.)

System_CAPS_protmethodDispose(Boolean)

Disposes the object and the associated cancellation token.(Overrides Package::Dispose(Boolean).)

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodFindToolWindow(Type^, Int32, Boolean)

Gets the tool window corresponding to the specified type and ID.(Inherited from Package.)

System_CAPS_pubmethodFindWindowPane(Type^, Int32, Boolean)

Gets the window pane corresponding to the specified type and ID, and if no window pane of that type exists creates one if told to do so.(Inherited from Package.)

System_CAPS_protmethodGetAutomationObject(String^)

Gets the automation object for the VSPackage.(Inherited from Package.)

System_CAPS_pubmethodGetDialogPage(Type^)

Gets the requested dialog page.(Inherited from Package.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetOutputPane(Guid, String^)

Gets the requested output window.(Inherited from Package.)

System_CAPS_pubmethodGetProviderLocale()

Returns the locale associated with this service provider.(Inherited from Package.)

System_CAPS_protmethodGetService(Type^)

Retrieves a service registered with this package. This method is synchronous and even async services retrieved this way will be retrieved synchronously.(Overrides Package::GetService(Type^).)

System_CAPS_pubmethodGetServiceAsync(Type^)

System_CAPS_protmethodGetToolboxItemData(String^, DataFormats::Format^)

Gets the content of the data format for the specified toolbox item ID and data format. (Inherited from Package.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodInitialize()

Seal this method. Due to an almost unavoidable risk of deadlock, SetSite (which is what calls Initialize) still occurs on the UI thread even for async package. Since most async package authors would, logically, assume that Initialize happens on a b/g thread they may do expensive (synchronous) things inside of their override, defeating some of the benefit of async loads. To help lead them away from that we will seal it and thus all they can override is async initialize, which is called on the b/g thread.(Overrides Package::Initialize().)

System_CAPS_protmethodInitializeAsync(CancellationToken, IProgress<ServiceProgressData^>^)

System_CAPS_protmethodInstantiateToolWindow(Type^)

(Inherited from Package.)

System_CAPS_pubmethodIsLocalService(Type^)

Determines whether the specified service type can be retrieved without requiring an RPC transition to the UI thread.(Inherited from Package.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnLoadOptions(String^, Stream^)

Invoked by the package class when there are options to be read out of the solution file.(Inherited from Package.)

System_CAPS_protmethodOnSaveOptions(String^, Stream^)

Invoked by the Package class when there are options to be saved to the solution file. (Inherited from Package.)

System_CAPS_pubmethodParseToolboxResource(TextReader^, Guid)

Parses an embedded text resource of appropriate format for information about which items should be added to the Toolbox.(Inherited from Package.)

System_CAPS_pubmethodParseToolboxResource(TextReader^, ResourceManager^)

Parses an embedded text resource of appropriate format for information about which items should be added to the Toolbox.(Inherited from Package.)

System_CAPS_protmethodQueryClose(Boolean)

Called to ask the package if the shell can be closed.(Inherited from Package.)

System_CAPS_protmethodRegisterEditorFactory(IVsEditorFactory^)

Registers an editor factory with Visual Studio.(Inherited from Package.)

System_CAPS_protmethodRegisterProjectFactory(IVsProjectFactory^)

Registers a project factory with Visual Studio.(Inherited from Package.)

System_CAPS_pubmethodRemoveService(Type^)

Removes an async service registered with this package.

System_CAPS_pubmethodRemoveService(Type^, Boolean)

Removes an async service registered with this package.

System_CAPS_pubmethodShowOptionPage(Type^)

Displays a specified tools options page.(Inherited from Package.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubmethodQueryService(Guid)

Overloaded. Gets a service exposed by a service provider based on its service type.(Defined by PackageUtilities.)

System_CAPS_pubmethodQueryService<TService>()

Overloaded. Gets a service exposed by a service provider based on its service type.(Defined by PackageUtilities.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleCommandTarget::Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)

Executes a specified command or displays help for a command.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleCommandTarget::QueryStatus(Guid, UInt32, array<OLECMD>^, IntPtr)

Queries the object for the status of one or more commands generated by user interface events.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIServiceProvider::QueryService(Guid, Guid, IntPtr)

This API supports the product infrastructure and is not intended to be used directly from your code. Internal IServiceProvider implementation.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAsyncLoadablePackageInitialize::Initialize(IAsyncServiceProvider^, IProfferAsyncService^, IAsyncProgressCallback^)

Async version of SetSite, called from a background thread.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAsyncServiceProvider::QueryServiceAsync(Guid)

Gets the async service, if it is available.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPackage::Close()

This API supports the product infrastructure and is not intended to be used directly from your code. Closes and disposes the package.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPackage::GetAutomationObject(String^, Object^)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an automation-friendly object for this package.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPackage::GetPropertyPage(Guid, array<VSPROPSHEETPAGE>^)

This API supports the product infrastructure and is not intended to be used directly from your code. Proffers access to the Tools menu Options and the property pages of the Customize Toolbox dialog boxes.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPackage::QueryClose(Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Called to ask the VSPackage if the Visual Studio shell can be closed.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPackage::ResetDefaults(UInt32)

This API supports the product infrastructure and is not intended to be used directly from your code. Resets Toolbox defaults.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPackage::SetSite(IServiceProvider^)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes the VSPackage in the Visual Studio environment.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPersistSolutionOpts::LoadUserOptions(IVsSolutionPersistence^, UInt32)

This API supports the product infrastructure and is not intended to be used directly from your code. Loads user options for a given solution.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPersistSolutionOpts::ReadUserOptions(IStream^, String^)

This API supports the product infrastructure and is not intended to be used directly from your code. Reads user options for a given solution.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPersistSolutionOpts::SaveUserOptions(IVsSolutionPersistence^)

This API supports the product infrastructure and is not intended to be used directly from your code. Saves user options for a given solution.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsPersistSolutionOpts::WriteUserOptions(IStream^, String^)

This API supports the product infrastructure and is not intended to be used directly from your code. Writes user options for a given solution.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsToolboxItemProvider::GetItemContent(String^, UInt16, IntPtr)

Gets an item.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsToolWindowFactory::CreateToolWindow(Guid, UInt32)

This API supports the product infrastructure and is not intended to be used directly from your code. Creates a tool window of the specified type with the specified ID.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUserSettings::ExportSettings(String^, IVsSettingsWriter^)

This method implements the IVsUserSettings Interface used to manage profiles and import/export settings to XML files.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUserSettings::ImportSettings(String^, IVsSettingsReader^, UInt32, Int32)

Retrieves a VSPackage's configuration using the Visual Studio settings mechanism when a user selects the import option of the Import/Export Settings feature on the IDE’s Tools menu. This method is part of the implementation of the IVsUserSettings interface used to manage profiles and import/export settings to XML files.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUserSettingsMigration::MigrateSettings(IVsSettingsReader^, IVsSettingsWriter^, String^)

Migrates settings from a previous version.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUserSettingsQuery::NeedExport(String^, Int32)

Determines whether settings have changed and should be re-exported.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIServiceContainer::AddService(Type^, Object^)

This API supports the product infrastructure and is not intended to be used directly from your code. Adds the given service to the VSPackage's service container.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIServiceContainer::AddService(Type^, Object^, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Adds the given service to the VSPackage's service container.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIServiceContainer::AddService(Type^, ServiceCreatorCallback^)

This API supports the product infrastructure and is not intended to be used directly from your code. Adds the given service to the VSPackage's service container.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIServiceContainer::AddService(Type^, ServiceCreatorCallback^, Boolean)

Adds the given service to the service container by means of the specified ServiceCreatorCallback.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIServiceContainer::RemoveService(Type^)

This API supports the product infrastructure and is not intended to be used directly from your code. Removes the given service type from the service container.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIServiceContainer::RemoveService(Type^, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Removes the given service type from the service container, and optionally promotes the removal of the service to parent service containers.(Inherited from Package.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIServiceProvider::GetService(Type^)

Gets the service of the specified type.(Inherited from Package.)

Return to top
Show: