Export (0) Print
Expand All

ToolWindowPane Class

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

System.Object
  Microsoft.VisualStudio.Shell.WindowPane
    Microsoft.VisualStudio.Shell.ToolWindowPane

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)

[ComVisibleAttribute(true)]
public class ToolWindowPane : WindowPane

The ToolWindowPane type exposes the following members.

  NameDescription
Public methodToolWindowPane()Initializes a new instance of ToolWindowPane with a null service provider
Protected methodToolWindowPane(IServiceProvider)Initializes an instance of this class.
Top

  NameDescription
Public propertyBitmapIndexGets or sets the index of the image in the bitmap strip to use for the window frame icon.
Public propertyBitmapResourceIDGets or sets the resource ID for the bitmap strip from which to take the window frame icon.
Public propertyCaptionGets or sets the caption for the tool window.
Public propertyContentGets or sets the content of this tool window. (Inherited from WindowPane.)
Public propertyFrameGets or sets the IVsWindowFrame that hosts the ToolWindowPane.
Protected propertyInitializationModeGets the initialization mode that is associated with this window pane. (Inherited from WindowPane.)
Public propertyPackageGets or sets the package that owns the tool window.
Public propertyToolBarGets or sets the CommandID.
Public propertyToolBarDropTargetGets or sets the toolbar drop target.
Public propertyToolBarLocationGets or sets the location of the toolbar in the tool window.
Public propertyToolClsidGets or sets the CLSID of a tool that should be used for this tool window.
Public propertyWindowGets the window associated with this window pane. (Inherited from WindowPane.)
Top

  NameDescription
Public methodDispose()Disposes the window pane and its resources. (Inherited from WindowPane.)
Protected methodDispose(Boolean)Disposes the resources of the window pane. (Inherited from WindowPane.)
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 methodGetIVsWindowPaneGets the IVsWindowPane that is associated with the tool window.
Protected methodGetServiceGets the service of the specified type. (Inherited from WindowPane.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitializeInitializes services after the window pane has been sited. (Inherited from WindowPane.)
Public methodLoadUIStateOverride to load the previously saved state of the pane. (Inherited from WindowPane.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnCloseRaised when the window is closed. (Inherited from WindowPane.)
Protected methodOnCreateRaised when the window pane is created. (Inherited from WindowPane.)
Public methodOnToolBarAddedCalled when a toolbar is added to the tool window.
Public methodOnToolWindowCreatedThis method can be overridden by the derived class to execute any code that must run after the creation of IVsWindowFrame.
Protected methodPreProcessMessagePreprocesses the messages from navigation keys. (Inherited from WindowPane.)
Public methodSaveUIStateOverride to save custom state information to be used later when the pane is reconstructed. (Inherited from WindowPane.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIServiceProvider.GetServiceGets the service of the specified type. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIOleCommandTarget.ExecExecutes the specified command. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIOleCommandTarget.QueryStatusGets the status of the commands. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsUIElementPane.CloseUIElementPaneCloses the pane. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsUIElementPane.CreateUIElementPaneCreates the pane. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsUIElementPane.GetDefaultUIElementSizeWhen implemented in a derived class, gets the default size of the pane. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsUIElementPane.LoadUIElementStateWhen implemented in a derived class, loads custom state storage. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsUIElementPane.SaveUIElementStateStores the state of the pane to the specified stream. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsUIElementPane.SetUIElementSiteSets the site for this window pane. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsUIElementPane.TranslateUIElementAcceleratorHandles keyboard accelerators before the shell processes the message. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsWindowPane.ClosePane Obsolete. Closes the window pane. Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsWindowPane.CreatePaneWindow Obsolete. Creates a window pane. Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsWindowPane.GetDefaultSize Obsolete. Gets the default size of the window pane. Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsWindowPane.LoadViewState Obsolete. Loads the saved view state. Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsWindowPane.SaveViewState Obsolete. Saves the loaded view state. Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsWindowPane.SetSite Obsolete. Initializes this window pane with the specified service provider. Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate methodIVsWindowPane.TranslateAccelerator Obsolete. Handles the translation of navigation keys. Obsolete (Inherited from WindowPane.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft