https://github.com/madskristensen/asynctoolwindowsample

A Visual Studio extension sample
https://github.com/madskristensen/asynctoolwindowsample

async toolwindow visual-studio-extension vsix

Last synced: 12 months ago
JSON representation

A Visual Studio extension sample

• Host: GitHub
• URL: https://github.com/madskristensen/asynctoolwindowsample
• Owner: madskristensen
• License: other
• Created: 2018-05-22T19:05:42.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-22T19:33:50.000Z (about 8 years ago)
• Last Synced: 2025-03-21T18:51:52.454Z (about 1 year ago)
• Topics: async, toolwindow, visual-studio-extension, vsix
• Language: C#
• Size: 80.1 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Async Tool Window example

[![Build status](https://ci.appveyor.com/api/projects/status/eo79i4hqbn4jahqx?svg=true)](https://ci.appveyor.com/project/madskristensen/asynctoolwindowsample)

**Applies to Visual Studio 2017.6 and newer**

This sample shows how to provide an Async Tool Window in a Visual Studio extension.

Clone the repo to test out the sample in Visual Studio 2017 yourself.

![Tool Window](art/tool-window.png)

## Specify minimum supported version

Since protocol handler support is new in Visual Studio 2017 Update 6, we need to specify that our extension requires that version or newer. We do that in the .vsixmanifest file like so:

```xml

```

*15.0.27413* is the full version string of Visual Studio 2017 Update 6.

See the full sample [.vsixmanifest file](src/source.extension.vsixmanifest).

## This sample

The code in this sample contains the concepts:

1. [Custom Tool Window Pane](src/ToolWindows/SampleToolWindow.cs)

2. [XAML control](src/ToolWindows/SampleToolWindowControl.xaml) for the pane

3. [Custom command](src/Commands/ShowToolWindow.cs) that can show the tool window

4. [AsyncPackage class](src/MyPackage.cs) that glues it all together

Follow the links above directly into the source code to see how it is all hooked up.

## Further reading

Read the docs for all the details surrounding these scenarios.

* [VSCT Schema Reference](https://docs.microsoft.com/en-us/visualstudio/extensibility/vsct-xml-schema-reference)

* [Use AsyncPackage with background load](https://docs.microsoft.com/en-us/visualstudio/extensibility/how-to-use-asyncpackage-to-load-vspackages-in-the-background)

* [Custom command sample](https://github.com/madskristensen/CustomCommandSample)