developer/VSSDK/VisualStudioIntegration/Common/Source/CSharp/Shell90/ToolWindowPane.cs

   1 //------------------------------------------------------------------------------
   2 // <copyright file="ToolWindowPane.cs" company="Microsoft">
   3 //     Copyright (c) Microsoft Corporation.  All rights reserved.
   4 // </copyright>
   5 //------------------------------------------------------------------------------
   6
   7 using System;
   8 using System.Collections;
   9 using System.ComponentModel;
  10 using System.ComponentModel.Design;
  11 using System.Diagnostics;
  12 using System.Drawing;
  13 using System.Runtime.InteropServices;
  14 using System.Windows.Forms;
  15 using Microsoft.VisualStudio.OLE.Interop;
  16 using Microsoft.VisualStudio.Shell.Interop;
  17
  18 using IOleServiceProvider = Microsoft.VisualStudio.OLE.Interop.IServiceProvider;
  19 using IServiceProvider = System.IServiceProvider;
  20
  21 namespace Microsoft.VisualStudio.Shell
  22 {
  23     /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane"]/*' />
  24     /// <summary>
  25     /// Summary description for ToolWindowPane.
  26     /// </summary>
  27     [System.Runtime.InteropServices.ComVisible(true)]
  28     public abstract class ToolWindowPane : WindowPane
  29     {
  30         private string caption;
  31         private IVsWindowFrame frame = null;
  32         private Microsoft.VisualStudio.Shell.Package package = null;
  33         private CommandID toolBarCommandID = null;
  34         private VSTWT_LOCATION toolBarLocation;
  35         private int bitmapResourceID;
  36         private int bitmapIndex;
  37         private Guid toolClsid;
  38
  39         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.ToolWindowPane"]/*' />
  40         /// <summary>
  41         /// Constructor
  42         /// </summary>
  43         protected ToolWindowPane(IServiceProvider provider)
  44         :
  45         base(provider)
  46         {
  47             toolClsid = Guid.Empty;
  48             bitmapIndex = -1;
  49             bitmapResourceID = -1;
  50             toolBarLocation = VSTWT_LOCATION.VSTWT_TOP;
  51         }
  52
  53         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.Caption"]/*' />
  54         /// <summary>
  55         /// Get or Set the text on the title bar of the ToolWindow
  56         /// </summary>
  57         /// <value></value>
  58         public string Caption
  59         {
  60             get { return caption; }
  61             set
  62             {
  63                 caption = value;
  64                 if (frame != null && caption != null)
  65                 {
  66                     // Since the window is already created, set the coresponding property
  67                     int hr = NativeMethods.S_OK;
  68                     try {
  69                         hr = frame.SetProperty((int)__VSFPROPID.VSFPROPID_Caption, caption);
  70                     } catch (COMException e) {
  71                         hr = e.ErrorCode;
  72                     }
  73                     Debug.Assert(hr >= 0, "Failed to set caption on toolwindow");
  74                 }
  75             }
  76         }
  77
  78         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.Frame"]/*' />
  79         /// <summary>
  80         /// Get or Set the Frame (IvsWindowFrame) hosting the ToolWindow
  81         /// </summary>
  82         public object Frame
  83         {
  84             get { return frame; }
  85             set
  86             {
  87                 frame = (IVsWindowFrame)value;
  88                 // Fire the event to let any custom creation code run
  89                 OnToolWindowCreated();
  90             }
  91         }
  92
  93         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.Package"]/*' />
  94         /// <summary>
  95         /// Get or Set the Package (Microsoft.VisualStudio.Shell.Package) owning the ToolWindow.
  96         /// This should only be set by the base Package class when it creates the toolwindow.
  97         /// </summary>
  98         public object Package
  99         {
 100             get { return package; }
 101             set
 102             {
 103                 if (frame != null || package != null)
 104                     throw new NotSupportedException(Resources.ToolWindow_PackageOnlySetByCreator);
 105                 package = (Microsoft.VisualStudio.Shell.Package)value;
 106             }
 107         }
 108
 109         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.ToolBar"]/*' />
 110         /// <summary>
 111         /// If the toolwindow has a ToolBar, it is described by this parameter.
 112         /// Otherwise this is null
 113         /// </summary>
 114         public CommandID ToolBar
 115         {
 116             get { return toolBarCommandID; }
 117             set
 118             {
 119                 if (frame != null)
 120                     throw new Exception(Resources.ToolWindow_TooLateToAddToolbar);
 121                 toolBarCommandID = value;
 122             }
 123         }
 124
 125         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.ToolBarLocation"]/*' />
 126         /// <summary>
 127         /// Get or Set where the toolbar should be in the tool window (Up, down, left, right).
 128         /// This parameter is based on VSTWT_LOCATION
 129         /// </summary>
 130         public int ToolBarLocation
 131         {
 132             get { return (int)toolBarLocation; }
 133             set
 134             {
 135                 if (frame != null)
 136                     throw new Exception(Resources.ToolWindow_TooLateToAddToolbar);
 137                 toolBarLocation = (VSTWT_LOCATION)value;
 138             }
 139         }
 140
 141         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.ToolClsid"]/*' />
 142         /// <summary>
 143         /// This is used to specify the CLSID of a tool that should be used for this toolwindow
 144         /// </summary>
 145         public Guid ToolClsid
 146         {
 147             get { return toolClsid; }
 148             set
 149             {
 150                 if (frame != null)
 151                     throw new Exception(Resources.ToolWindow_TooLateToAddTool);
 152                 toolClsid = value;
 153             }
 154         }
 155
 156         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.BitmapResourceID"]/*' />
 157         /// <summary>
 158         /// Get or Set the resource ID for the bitmap strip from which to take the window frame icon
 159         /// </summary>
 160         public int BitmapResourceID
 161         {
 162             get { return bitmapResourceID; }
 163             set
 164             {
 165                 bitmapResourceID = value;
 166                 if (frame != null && bitmapResourceID != -1)
 167                 {
 168                     int hr = NativeMethods.S_OK;
 169                     // Since the window is already created, set the coresponding property
 170                     try {
 171                         hr = frame.SetProperty((int)__VSFPROPID.VSFPROPID_BitmapResource, bitmapResourceID);
 172                     } catch (COMException e) {
 173                         hr = e.ErrorCode;
 174                     }
 175                     Debug.Assert(hr >= 0, "Failed to set bitmap resource on toolwindow");
 176                 }
 177             }
 178         }
 179
 180         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.BitmapIndex"]/*' />
 181         /// <summary>
 182         /// Get or Set the index of the image to use in the bitmap strip for the window frame icon
 183         /// </summary>
 184         public int BitmapIndex
 185         {
 186             get { return bitmapIndex; }
 187             set
 188             {
 189                 bitmapIndex = value;
 190                 if (frame != null && bitmapIndex != -1)
 191                 {
 192                     int hr = NativeMethods.S_OK;
 193                     // Since the window is already created, set the coresponding property
 194                     try {
 195                         hr = frame.SetProperty((int)__VSFPROPID.VSFPROPID_BitmapIndex, bitmapIndex);
 196                     } catch (COMException e) {
 197                         hr = e.ErrorCode;
 198                     }
 199                     Debug.Assert(hr >= 0, "Failed to set bitmap index on toolwindow");
 200                 }
 201             }
 202         }
 203
 204         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.GetIVsWindowPane"]/*' />
 205         /// <summary>
 206         /// This method make it possible to provide an IVsWindowPane not derived from ToolWindowPane
 207         /// To support that scenario one would override this method and create their IVsWindowPane and
 208         /// return it.
 209         /// </summary>
 210         /// <returns>IVsWindowPane to be hosted in the toolwindow frame</returns>
 211         public virtual object GetIVsWindowPane()
 212         {
 213             return (IVsWindowPane)this;
 214         }
 215
 216         /// <include file='doc\ToolWindowPane.uex' path='docs/doc[@for="ToolWindowPane.OnToolWindowCreated"]/*' />
 217         /// <summary>
 218         /// This method can be overriden by the derived class to execute
 219         /// any code that needs to run after the IVsWindowFrame is created.
 220         /// If the toolwindow has a toolbar with a combobox, it should make
 221         /// sure its command handler are set by the time they return from
 222         /// this method.
 223         /// This is called when someone set the Frame property.
 224         /// </summary>
 225         public virtual void OnToolWindowCreated()
 226         {
 227             Debug.Assert(frame != null, "Frame should be set before this method is called");
 228
 229             // If any property were set, set them on the frame (setting our properties will take care of it)
 230             Caption = caption;
 231             BitmapResourceID = bitmapResourceID;
 232             BitmapIndex = bitmapIndex;
 233         }
 234
 235         /// <summary>
 236         /// This should be overriden if you want to run code before the window is shown
 237         /// but after its toolbar is added.
 238         /// </summary>
 239         public virtual void OnToolBarAdded()
 240         {
 241         }
 242     }
 243 }