ToolWindowPane Class
A default implementation for a tool window. It can be subclassed to implement a customized tool window.
Namespace:
Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)
The ToolWindowPane type exposes the following members.
| Name | Description | |
|---|---|---|
|
ToolWindowPane() | Initializes a new instance of ToolWindowPane with a null service provider |
|
ToolWindowPane(IServiceProvider) | Initializes an instance of this class. |
| Name | Description | |
|---|---|---|
|
BitmapIndex | Gets or sets the index of the image in the bitmap strip to use for the window frame icon. |
|
|
BitmapResourceID | Gets or sets the resource ID for the bitmap strip from which to take the window frame icon. |
|
|
Caption | Gets or sets the caption for the tool window. |
|
|
Content | Gets or sets the content of this tool window. (Inherited from WindowPane.) |
|
|
Frame | Gets or sets the IVsWindowFrame that hosts the ToolWindowPane. |
|
InitializationMode | Gets the initialization mode that is associated with this window pane. (Inherited from WindowPane.) |
|
|
Package | Gets or sets the package that owns the tool window. |
|
|
ToolBar | Gets or sets the CommandID. |
|
|
ToolBarDropTarget | Gets or sets the toolbar drop target. |
|
|
ToolBarLocation | Gets or sets the location of the toolbar in the tool window. |
|
|
ToolClsid | Gets or sets the CLSID of a tool that should be used for this tool window. |
|
|
Window | Gets the window associated with this window pane. (Inherited from WindowPane.) |
| Name | Description | |
|---|---|---|
|
|
Dispose() | Disposes the window pane and its resources. (Inherited from WindowPane.) |
|
|
Dispose(Boolean) | Disposes the resources of the window pane. (Inherited from WindowPane.) |
|
|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetIVsWindowPane | Gets the IVsWindowPane that is associated with the tool window. |
|
|
GetService | Gets the service of the specified type. (Inherited from WindowPane.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
Initialize | Initializes services after the window pane has been sited. (Inherited from WindowPane.) |
|
|
LoadUIState | Override to load the previously saved state of the pane. (Inherited from WindowPane.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
OnClose | Raised when the window is closed. (Inherited from WindowPane.) |
|
|
OnCreate | Raised when the window pane is created. (Inherited from WindowPane.) |
|
|
OnToolBarAdded | Called when a toolbar is added to the tool window. |
|
|
OnToolWindowCreated | This method can be overridden by the derived class to execute any code that must run after the creation of IVsWindowFrame. |
|
|
PreProcessMessage | Preprocesses the messages from navigation keys. (Inherited from WindowPane.) |
|
|
SaveUIState | Override to save custom state information to be used later when the pane is reconstructed. (Inherited from WindowPane.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
|
IServiceProvider.GetService | Gets the service of the specified type. (Inherited from WindowPane.) |
|
|
IOleCommandTarget.Exec | Executes the specified command. (Inherited from WindowPane.) |
|
|
IOleCommandTarget.QueryStatus | Gets the status of the commands. (Inherited from WindowPane.) |
|
|
IVsUIElementPane.CloseUIElementPane | Closes the pane. (Inherited from WindowPane.) |
|
|
IVsUIElementPane.CreateUIElementPane | Creates the pane. (Inherited from WindowPane.) |
|
|
IVsUIElementPane.GetDefaultUIElementSize | When implemented in a derived class, gets the default size of the pane. (Inherited from WindowPane.) |
|
|
IVsUIElementPane.LoadUIElementState | When implemented in a derived class, loads custom state storage. (Inherited from WindowPane.) |
|
|
IVsUIElementPane.SaveUIElementState | Stores the state of the pane to the specified stream. (Inherited from WindowPane.) |
|
|
IVsUIElementPane.SetUIElementSite | Sets the site for this window pane. (Inherited from WindowPane.) |
|
|
IVsUIElementPane.TranslateUIElementAccelerator | Handles keyboard accelerators before the shell processes the message. (Inherited from WindowPane.) |
|
|
IVsWindowPane.ClosePane | Obsolete. Closes the window pane. Obsolete. (Inherited from WindowPane.) |
|
|
IVsWindowPane.CreatePaneWindow | Obsolete. Creates a window pane. Obsolete. (Inherited from WindowPane.) |
|
|
IVsWindowPane.GetDefaultSize | Obsolete. Gets the default size of the window pane. Obsolete. (Inherited from WindowPane.) |
|
|
IVsWindowPane.LoadViewState | Obsolete. Loads the saved view state. Obsolete. (Inherited from WindowPane.) |
|
|
IVsWindowPane.SaveViewState | Obsolete. Saves the loaded view state. Obsolete. (Inherited from WindowPane.) |
|
|
IVsWindowPane.SetSite | Obsolete. Initializes this window pane with the specified service provider. Obsolete. (Inherited from WindowPane.) |
|
|
IVsWindowPane.TranslateAccelerator | Obsolete. Handles the translation of navigation keys. Obsolete (Inherited from WindowPane.) |
Derives from WindowPane and inherits the default services that WindowPane provides. Derived tool windows must offer a public constructor that takes a service provider. Visual Studio uses this constructor when it creates an instance of the tool window.
