Share via


ToolWindowPane Members

Include Protected Members
Include Inherited Members

A default implementation for a tool window. It can be subclassed to implement a customized tool window.

The ToolWindowPane type exposes the following members.

Constructors

 

Name

Description

Protected method

ToolWindowPane

Initializes an instance of this class.

Top

Methods

 

Name

Description

Public method

Dispose

Overloaded. Disposes the window pane and its resources.

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Protected method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Public method

GetIVsWindowPane

Gets the IVsWindowPane that is associated with the tool window.

Protected method

GetService

Gets the service of the specified type. (Inherited from WindowPane.)

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Protected method

Initialize

Initializes services after the window pane has been sited. (Inherited from WindowPane.)

Protected method

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Protected method

OnClose

Raised when the window is closed. (Inherited from WindowPane.)

Protected method

OnCreate

Raised when the window pane is created. (Inherited from WindowPane.)

Public method

OnToolBarAdded

Called when a toolbar is added to the tool window.

Public method

OnToolWindowCreated

This method can be overridden by the derived class to execute any code that must run after the creation of IVsWindowFrame.

Protected method

PreProcessMessage

Preprocesses the messages from navigation keys. (Inherited from WindowPane.)

Public method

ToString

Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

 

Name

Description

Public property

BitmapIndex

Gets or sets the index of the image in the bitmap strip to use for the window frame icon.

Public property

BitmapResourceID

Gets or sets the resource ID for the bitmap strip from which to take the window frame icon.

Public property

Caption

Gets or sets the caption for the tool window.

Public property

Frame

Gets or sets the IVsWindowFrame that hosts the ToolWindowPane.

Public property

Package

Gets or sets the package that owns the tool window.

Public property

ToolBar

Gets or sets the CommandID.

Public property

ToolBarLocation

Gets or sets the location of the toolbar in the tool window.

Public property

ToolClsid

Gets or sets the CLSID of a tool that should be used for this tool window.

Public property

Window

Gets the window that is associated with this window pane. (Inherited from WindowPane.)

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate method

IVsWindowPane.ClosePane

Closes the window pane. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.CreatePaneWindow

Creates a window pane. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IOleCommandTarget.Exec

Executes the specified command. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.GetDefaultSize

Gets the default size of the window pane. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IServiceProvider.GetService

Gets the service of the specified type. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.LoadViewState

Loads the saved view state. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsBroadcastMessageEvents.OnBroadcastMessage

Raised when a message is broadcast to the window. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IOleCommandTarget.QueryStatus

Queries the object for the status of one or more commands that are generated by user interface events. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.SaveViewState

Saves the loaded view state. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.SetSite

Initializes this window pane with the specified service provider. (Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.TranslateAccelerator

Handles the translation of navigation keys. (Inherited from WindowPane.)

Top

See Also

Reference

ToolWindowPane Class

Microsoft.VisualStudio.Shell Namespace