AsyncModelingPackage Class

Gets the root registry key of the current Visual Studio registry hive.

Exposes a CancellationToken that can be used to check if the package has been disposed. This can happen for async tasks that are running on a background thread when Visual Studio has started to shut down. Use ShutdownToken for an earlier indication that VS is shutting down.

Gets the collection of asynchronous tasks started by this package.

Gets the factory to use for asynchronous tasks started by this package.

Helper for locating model element references.

Gets the path to user data storage for Visual Studio.

Returns the path to user data storage for Visual Studio. Typically this is %USERPROFILE%\Local Settings\Application Data
Visual Studio[ver] but this can change based on any alternate root that the shell was initialized with.

Returns the registry root for the current user. Typically this is HKCU\Software\Microsoft\VisualStudio[ver] but this can change based on any alternate root that the shell is initialized with. This key is read-write.

Gets a value indicating whether the package in the process of shutdown.

Adds a user option key name into the list of option keys.

Add a toolbox item if it is not present. Will replace an existing toolbox item if the item is already present

Adds an async service to this package, specifying whether the service will be visible outside of this package.

Adds an async service to this package. The service will not be visible outside of this package.

Adds an async service to this package that supports progress updates during initialization. This service may or may not be visible outside of this package, depending on the value of promote.

Adds an async service that supports progress updates during initialization to this package. The service will not be visible outside of this package.

Add the passed collection of ModelingToolboxItemBase items into the Visual Studio toolbox.

We will provide basic tool window support for now, to see if things work. This should be done at the base Package level, in a similar fashion to proferred services.

Create the specified COM object using Visual Studio's ILocalRegistry and cast it to the given managed type. If VS cannot create it, then fall back to Activator.CreateInstance. This allows managed classes to be registered in local to the particular VS version in HKLM\Software\Microsoft\VisualStudio\8.0\clsid.

Factory method to create a ModelElementLocator instance for this package.

Creates a settings observer object for the package. This method is called when unified settings are active, but only if the package has one or more ProvideSettingsObserverAttributes.

Enables derived classes to provide an implementation if necessary.

When overriden in a derived class, returns the list of dynamic/custom toolbox items provided by this package.

Creates a tool window of the specified type with the specified ID.

Create the specified tool window.

Create a tool window of the specified type with the specified ID.

Create a tool window of the specified type with the specified ID. This is the only method that should be calling IVsUiShell.CreateToolWindow()

Creates a tool window of the specified type with the specified ID.

Creates a tool window of the specified type with the specified ID.

Disposes the object and the associated cancellation token.

Gets the tool window corresponding to the specified type and ID.

Asynchronously locates the tool window corresponding to the specified type and ID. If it does not exist, it creates and returns one if create is true, or returns null if create is false.

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.

Asynchronously locates the window pane corresponding to the specified type and ID. If it does not exist, it creates and returns one if create is true, or returns null if create is false.

Returns the asynchronous tool window factory interface for the tool window identified by toolWindowType, if asynchronous creation is supported for the tool window. If asynchronous creation is not supported, null is returned.

Gets the automation object for the VSPackage.

Gets the requested dialog page.

Gets the requested output window.

Returns the locale associated with this service provider.

Retrieves a service registered with this package synchronously, falling back to the asynchronous GlobalProvider and synchronous GlobalProvider if there is no service with this identity registered with the package.

Retrieves an async service registered with this package asynchronously, falling back to the asynchronous GlobalProvider and synchronous GlobalProvider if there is no service with this identity registered with the package. It also allows specifying a hint whether to throw an exception if it could not be retrieved, it does not, however, guarantee exceptions will be thrown for all failure cases.

Retrieves an async service registered with this package asynchronously, falling back to the asynchronous GlobalProvider and synchronous GlobalProvider if there is no service with this identity registered with the package.

Retrieves an async service registered with this package asynchronously, falling back to the asynchronous GlobalProvider and synchronous GlobalProvider if there is no service with this identity registered with the package. It also allows specifying whether to throw an exception if it could not be retrieved.

Gets the content of the data format for the specified toolbox item ID and data format.

Returns the tool window instance corresponding to the given type. We only support single-instance tool windows, so this will always be a 1-1 mapping.

Returns the tool window instance corresponding to the given type. We only support single-instance tool windows, so this will always be a 1-1 mapping.

Returns the title string to use for the tool window. If null is returned, the tool window's type name is used for the title.

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.

Derived classes should override this method to do package-specific work such as registering editor factories

Performs initialization in preparation for creating the tool window identified by toolWindowType.

Construct a tool window of the specified type.

Determines whether the specified service type can be retrieved without requiring an RPC transition to the UI thread.

When overridden by a derived class, may initiate operations with side effects that are not strictly part of package load that would belong to InitializeAsync(CancellationToken, IProgress<ServiceProgressData>) that should happen soon after package load (e.g. updating command status). This method is invoked from a background thread.

Invoked by the package class when there are options to be read out of the solution file.

Invoked by the Package class when there are options to be saved to the solution file.

Event handler for ToolboxInitialized event The dynamic/custom toolbox items will be re-registered.

Event handler for ToolboxUpgraded event The dynamic/custom toolbox items will be re-registered.

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

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

Called to ask the package if the shell can be closed.

Registers an editor factory with Visual Studio.

Registers a project factory with Visual Studio.

Removes an async service registered with this package.

Removes an async service registered with this package.

Adds the dynamic/custom toolbox items.

Displays a specified tools options page.

Asynchronously shows the tool window corresponding to the specified type and ID. If it does not exist, it creates and returns one if create is true, or returns null if create is false.

Event generated whenever Visual Studio initializes its Toolbox.

Event generated whenever Visual Studio upgrades its Toolbox.

Async version of SetSite, mostly called from a background thread, but not always.

Async version of SetSite, called from a b/g thread.

Get an async initializing service that is offered by this package.

Get an async initializing service that is offered by this package.

Executes a specified command or displays help for a command.

Queries the object for the status of one or more commands generated by user interface events.

Adds the given service to the VSPackage's service container.

Adds the given service to the VSPackage's service container.

Adds the given service to the service container by means of the specified ServiceCreatorCallback.

Adds the given service to the VSPackage's service container.

Removes the given service type from the service container, and optionally promotes the removal of the service to parent service containers.

Removes the given service type from the service container.

Gets the service of the specified type.

Internal IServiceProvider implementation.

Creates a tool window of the specified type with the specified ID.

Returns the title string to use for the tool window. If null is returned, the tool window's type name is used for the title.

Performs initialization in preparation for creating the tool window identified by toolWindowType.

Instantiates Unified Settings observer identified by the given guid.

Closes and disposes the package.

Gets an automation-friendly object for this package.

Proffers access to the Tools menu Options and the property pages of the Customize Toolbox dialog boxes.

Called to ask the VSPackage if the Visual Studio shell can be closed.

Resets Toolbox defaults.

Initializes the VSPackage in the Visual Studio environment.

Loads user options for a given solution.

Reads user options for a given solution.

Saves user options for a given solution.

Writes user options for a given solution.

Gets an item.

Creates a tool window of the specified type with the specified ID.

This method implements the IVsUserSettings Interface used to manage profiles and import/export settings to XML files.

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.

Migrates settings from a previous version.

Determines whether settings have changed and should be re-exported.

Proffers a service implemented by the specified type to an async service container. When the service is queried the first time, the creator function will be called.

Proffers a service implemented by the specified type to an async service container. When the service is queried the first time, the creator function will be called. The proffered service will be promoted to the parent async service container.

Proffers a service implemented by the specified type to an async service container. When the service is queried the first time, the creator function will be called.

Proffers a service implemented by the specified type to an async service container. When the service is queried the first time, the creator function will be called. The proffered service will be promoted to the parent async service container.

Gets a service exposed by a service provider based on its service GUID.

Gets a service exposed by a service provider based on its service type.

Retrieves a proffered service asynchronously, specifying whether to throw an exception if it could not be retrieved.

Retrieves a proffered service asynchronously, specifying whether to throw an exception if it could not be retrieved.

Retrieves a proffered service asynchronously, throwing an exception if it could not be retrieved.

Retrieves a proffered service asynchronously, throwing an exception if it could not be retrieved.