VSSDK IDE Sample: Tool WPF Tool Windows

/***************************************************************************

Copyright (c) Microsoft Corporation. All rights reserved.
This code is licensed under the Visual Studio SDK license terms.
THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF
ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY
IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR
PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

***************************************************************************/

using System;
using System.ComponentModel.Design;
using System.Diagnostics;
using System.Globalization;
using System.Runtime.InteropServices;
using Microsoft.VisualStudio.Shell.Interop;

using MsVsShell = Microsoft.VisualStudio.Shell;
using ErrorHandler = Microsoft.VisualStudio.ErrorHandler;

namespace Microsoft.Samples.VisualStudio.IDE.ToolWindow
{
	/// <summary>
	/// The Package class is responsible for the following:
	///		- Attributes to enable registration of the components
	///		- Enable the creation of our tool windows
	///		- Respond to our commands
	/// 
	/// The following attributes are covered in other samples:
	///		PackageRegistration:   Reference.Package
	///		ProvideMenuResource:   Reference.MenuAndCommands
	/// 
	/// Our initialize method defines the command handlers for the commands that
	/// we provide under View|Other Windows to show our tool windows
	/// 
	/// The first new attribute we are using is ProvideToolWindow. That attribute
	/// is used to advertise that our package provides a tool window. In addition
	/// it can specify optional parameters to describe the default start location
	/// of the tool window. For example, the PersistedWindowPane will start tabbed
	/// with Solution Explorer. The default position is only used the very first
	/// time a tool window with a specific Guid is shown for a user. After that,
	/// the position is persisted based on the last known position of the window.
	/// When trying different default start positions, you may find it useful to
	/// delete *.prf from:
	///		"%USERPROFILE%\Application Data\Microsoft\VisualStudio\10.0Exp\"
	/// as this is where the positions of the tool windows are persisted.
	/// 
	/// To get the Guid corresponding to the Solution Explorer window, we ran this
	/// sample, made sure the Solution Explorer was visible, selected it in the
	/// Persisted Tool Window and looked at the properties in the Properties
	/// window. You can do the same for any window.
	/// 
	/// The DynamicWindowPane makes use of a different set of optional properties.
	/// First it specifies a default position and size (again note that this only
	/// affects the very first time the window is displayed). Then it specifies the
	/// Transient flag which means it will not be persisted when Visual Studio is
	/// closed and reopened.
	/// 
	/// The second new attribute is ProvideToolWindowVisibility. This attribute
	/// is used to specify that a tool window visibility should be controled
	/// by a UI Context. For a list of predefined UI Context, look in vsshell.idl
	/// and search for "UICONTEXT_". Since we are using the UICONTEXT_SolutionExists,
	/// this means that it is possible to cause the window to be displayed simply by
	/// creating a solution/project.
	/// </summary>
	[MsVsShell.ProvideToolWindow(typeof(PersistedWindowPane), Style = MsVsShell.VsDockStyle.Tabbed, Window = "3ae79031-e1bc-11d0-8f78-00a0c9110057")]
	[MsVsShell.ProvideToolWindow(typeof(DynamicWindowPane), PositionX=250, PositionY=250, Width=160, Height=180, Transient=true)]
	[MsVsShell.ProvideToolWindowVisibility(typeof(DynamicWindowPane), /*UICONTEXT_SolutionExists*/"f1536ef8-92ec-443c-9ed7-fdadf150da82")]

	[MsVsShell.ProvideMenuResource(1000, 1)]
	[MsVsShell.PackageRegistration(UseManagedResourcesOnly = true)]
	[Guid("01069CDD-95CE-4620-AC21-DDFF6C57F012")]
	public class PackageToolWindow : MsVsShell.Package
	{
		// Cache the Menu Command Service since we will use it multiple times
		private MsVsShell.OleMenuCommandService menuService;

		/// <summary>
		/// Package contructor.
		/// While we could have used the default constructor, adding the Trace makes it
		/// possible to verify that the package was created without having to set a break
		/// point in the debugger.
		/// </summary>
		public PackageToolWindow()
		{
			Trace.WriteLine(String.Format(CultureInfo.CurrentCulture, "Entering constructor for class {0}.", this.GetType().Name));
		}

		/// <summary>
		/// Initialization of the package; this is the place where you can put all the initilaization
		/// code that rely on services provided by VisualStudio.
		/// </summary>
		protected override void Initialize()
		{
			Trace.WriteLine(String.Format(CultureInfo.CurrentCulture, "Entering Initialize for class {0}.", this.GetType().Name));
			base.Initialize();

			// Create one object derived from MenuCommand for each command defined in
			// the VSCT file and add it to the command service.

			// Each command is uniquely identified by a Guid/integer pair.
			CommandID id = new CommandID(GuidsList.guidClientCmdSet, PkgCmdId.cmdidPersistedWindow);
			// Add the handler for the persisted window with selection tracking
			DefineCommandHandler(new EventHandler(this.ShowPersistedWindow), id);

			// Add the handler for the tool window with dynamic visibility and events
			id = new CommandID(GuidsList.guidClientCmdSet, PkgCmdId.cmdidUiEventsWindow);
			DefineCommandHandler(new EventHandler(this.ShowDynamicWindow), id);

		}

		/// <summary>
		/// Define a command handler.
		/// When the user press the button corresponding to the CommandID
		/// the EventHandler will be called.
		/// </summary>
		/// <param name="id">The CommandID (Guid/ID pair) as defined in the .vsct file</param>
		/// <param name="handler">Method that should be called to implement the command</param>
		/// <returns>The menu command. This can be used to set parameter such as the default visibility once the package is loaded</returns>
		internal MsVsShell.OleMenuCommand DefineCommandHandler(EventHandler handler, CommandID id)
		{
			// if the package is zombied, we don't want to add commands
			if (this.Zombied)
				return null;

			// Make sure we have the service
			if (menuService == null)
			{
				// Get the OleCommandService object provided by the MPF; this object is the one
				// responsible for handling the collection of commands implemented by the package.
				menuService = GetService(typeof(IMenuCommandService)) as MsVsShell.OleMenuCommandService;
			}
			MsVsShell.OleMenuCommand command = null;
			if (null != menuService)
			{
				// Add the command handler
				command = new MsVsShell.OleMenuCommand(handler, id);
				menuService.AddCommand(command);
			}
			return command;
		}

		/// <summary>
		/// This method loads a localized string based on the specified resource.
		/// </summary>
		/// <param name="resourceName">Resource to load</param>
		/// <returns>String loaded for the specified resource</returns>
		internal string GetResourceString(string resourceName)
		{
			string resourceValue;
			IVsResourceManager resourceManager = (IVsResourceManager)GetService(typeof(SVsResourceManager));
			if (resourceManager == null)
			{
				throw new InvalidOperationException("Could not get SVsResourceManager service. Make sure the package is Sited before calling this method");
			}
			Guid packageGuid = this.GetType().GUID;
			int hr = resourceManager.LoadResourceString(ref packageGuid, -1, resourceName, out resourceValue);
			Microsoft.VisualStudio.ErrorHandler.ThrowOnFailure(hr);
			return resourceValue;
		}

		/// <summary>
		/// Event handler for our menu item.
		/// This results in the tool window being shown.
		/// </summary>
		/// <param name="sender"></param>
		/// <param name="arguments"></param>
		private void ShowPersistedWindow(object sender, EventArgs arguments)
		{
			// Get the 1 (index 0) and only instance of our tool window (if it does not already exist it will get created)
			MsVsShell.ToolWindowPane pane = this.FindToolWindow(typeof(PersistedWindowPane), 0, true);
			if (pane == null)
			{
				throw new COMException(this.GetResourceString("@101"));
			}
			IVsWindowFrame frame = pane.Frame as IVsWindowFrame;
			if (frame == null)
			{
				throw new COMException(this.GetResourceString("@102"));
			}
			// Bring the tool window to the front and give it focus
			ErrorHandler.ThrowOnFailure(frame.Show());
		}

		/// <summary>
		/// Event handler for our menu item.
		/// This result in the tool window being shown.
		/// </summary>
		/// <param name="sender"></param>
		/// <param name="arguments"></param>
		private void ShowDynamicWindow(object sender, EventArgs arguments)
		{
			// Get the one (index 0) and only instance of our tool window (if it does not already exist it will get created)
			MsVsShell.ToolWindowPane pane = this.FindToolWindow(typeof(DynamicWindowPane), 0, true);
			if (pane == null)
			{
				throw new COMException(this.GetResourceString("@101"));
			}
			IVsWindowFrame frame = pane.Frame as IVsWindowFrame;
			if (frame == null)
			{
				throw new COMException(this.GetResourceString("@102"));
			}
			// Bring the tool window to the front and give it focus
			ErrorHandler.ThrowOnFailure(frame.Show());
		}
	}
}