ToolWindowBase Class

Visual Studio 2012

This class implements a base tool window for Team Foundation.

In Visual Studio tool windows are composed of a frame (implemented by the shell) and a pane, usually implemented by the package implementer.

This class derives from the ToolWindowPane class provided from the MPF in order to use its implementation of the IVsWindowPane interface.

Namespace:  Microsoft.VisualStudio.TeamFoundation
Assembly:  Microsoft.VisualStudio.TeamFoundation (in Microsoft.VisualStudio.TeamFoundation.dll)

public abstract class ToolWindowBase : ToolWindowPane, 
	IOleCommandTarget, IVsWindowFrameNotify, IVsWindowFrameNotify2

The ToolWindowBase type exposes the following members.

  NameDescription
Public methodToolWindowBaseStandard constructor for the tool window.
Top

  NameDescription
Public propertyBitmapIndex (Inherited from ToolWindowPane.)
Public propertyBitmapResourceID (Inherited from ToolWindowPane.)
Public propertyCaption (Inherited from ToolWindowPane.)
Public propertyCommandHandlerGet/Set the command handler
Public propertyContentOverridden to get/set the WPF content (Overrides WindowPane.Content.)
Public propertyFrame (Inherited from ToolWindowPane.)
Public propertyHelpTopicGet the help topic
Protected propertyInitializationMode (Inherited from WindowPane.)
Public propertyIsMultiInstanceReturns true if this is a multi instance tool window.
Public propertyIsOnScreentrue if the toolwindow is viewable on the screen and is not slid off screen (ie. auto-slide), not obstructed by another tabbed document, or closed. This differs from IsVisible which does not consider the toolwindow being slid off screen or the tabbed document being obstructed (ie. on top) by another.
Public propertyIsTransientReturns true if this is a transient tool window.
Public propertyPackage (Inherited from ToolWindowPane.)
Public propertySearchCategory (Inherited from ToolWindowPane.)
Public propertySearchEnabled (Inherited from ToolWindowPane.)
Public propertySearchFiltersEnum (Inherited from ToolWindowPane.)
Public propertySearchHost (Inherited from ToolWindowPane.)
Public propertySearchOptionsEnum (Inherited from ToolWindowPane.)
Public propertyServiceProviderGet the IOleServiceProvider interface.
Public propertyToolBar (Inherited from ToolWindowPane.)
Public propertyToolBarCommandTarget (Inherited from ToolWindowPane.)
Public propertyToolBarDropTarget (Inherited from ToolWindowPane.)
Public propertyToolBarLocation (Inherited from ToolWindowPane.)
Public propertyToolClsid (Inherited from ToolWindowPane.)
Public propertyWindow (Inherited from WindowPane.)
Public propertyWindowFrameToolwindow container frame
Top

  NameDescription
Public methodClearSearch (Inherited from ToolWindowPane.)
Public methodCloseClose this tool window.
Public methodCreateSearch (Inherited from ToolWindowPane.)
Public methodDispose() (Inherited from WindowPane.)
Protected methodDispose(Boolean) (Overrides WindowPane.Dispose(Boolean).)
Protected methodDisposeCleanupDispose components
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetIVsWindowPane (Inherited from ToolWindowPane.)
Protected methodGetService (Inherited from WindowPane.)
Protected methodGetToolWindowAttributeGet the package ProvideToolWindowAttribute for this tool window.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitialize (Inherited from WindowPane.)
Protected methodInitializeProxyControlSetup the tool window proxy control
Public methodInitializeViewPost construction initialization. NOTE: The view must be created in the constructor because VSIP needs the IWin32Window during the tool window instantiation.
Protected methodIOleCommandTargetExec
Protected methodIOleCommandTargetQueryStatus
Public methodLoadUIState (Inherited from WindowPane.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnClose() (Inherited from WindowPane.)
Public methodOnClose(UInt32)
Protected methodOnCloseCleanup
Protected methodOnCreate (Inherited from WindowPane.)
Public methodOnDockableChange
Public methodOnMove
Public methodOnNavigationKeyDown (Inherited from ToolWindowPane.)
Public methodOnShow
Public methodOnSize
Public methodOnToolBarAdded (Inherited from ToolWindowPane.)
Public methodOnToolWindowCreatedOnToolWindowCreated event handler. This is where key bindings will be hooked up. (Overrides ToolWindowPane.OnToolWindowCreated().)
Protected methodPreProcessMessage (Inherited from WindowPane.)
Public methodProvideSearchSettings (Inherited from ToolWindowPane.)
Public methodSaveUIState (Inherited from WindowPane.)
Protected methodSetFocusSet the focus to the view control
Protected methodSetUserContextSet the help topic for this tool window.
Protected methodSetUserSubContextSet the help topic for a specific context in this tool window. This help topic will be higher priority than the general tool window help topic.
Public methodShowShow this tool window.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUpdateCaptionUpdate the caption of the tool window and the visualizer title
Top

  NameDescription
Public eventToolWindowClosingEvent raised when the tool window is about to be closed
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft