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.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

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

[ComVisibleAttribute(true)]
public class ToolWindowPane : WindowPane, IVsWindowSearch

NameDescription
System_CAPS_pubmethodToolWindowPane()

Initializes a new instance of ToolWindowPane with a null service provider

System_CAPS_protmethodToolWindowPane(IServiceProvider)

Initializes an instance of this class.

NameDescription
System_CAPS_pubpropertyBitmapImageMoniker

Gets or sets the ImageMoniker for the icon for this tool window. This property should be used instead of BitmapResource and BitmapIndex to allow for DPI-aware icons.

System_CAPS_pubpropertyBitmapIndex

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

System_CAPS_pubpropertyBitmapResourceID

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

System_CAPS_pubpropertyCaption

Gets or sets the caption for the tool window.

System_CAPS_pubpropertyContent

Gets or sets the content of this tool window. (Inherited from WindowPane.)

System_CAPS_pubpropertyFrame

Gets or sets the IVsWindowFrame that hosts the ToolWindowPane.

System_CAPS_protpropertyInitializationMode

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

System_CAPS_pubpropertyPackage

Gets or sets the package that owns the tool window.

System_CAPS_pubpropertySearchCategory

Gets the search category that is used for storing MRU items. if the window search implementation for your tool window supporst most-recently-used search strings. By default, the toolwindow guid is used for the search category.

System_CAPS_pubpropertySearchEnabled

Override this if you want to support search in your window. You must also override other functions from the IVsWindowSearch interface, like CreateSearch, etc.

System_CAPS_pubpropertySearchFiltersEnum

Override this function if the tool window supports search filters. The class < WindowSearchFilterEnumerator can be used to construct an enumerator over an array of search filters that implement the IVsWindowSearchFilter interface.

System_CAPS_pubpropertySearchHost

Gets the search host implementation associated with this tool window.

System_CAPS_pubpropertySearchOptionsEnum

Override this function if the tool window supports search options. The class T:Microsoft.VisualStudio.PlatformUI.WindowSearchOptionEnumerator can be used to construct an enumerator over an array of search options implementing the IVsWindowSearchOption interface.

System_CAPS_pubpropertyToolBar

Gets or sets the CommandID.

System_CAPS_pubpropertyToolBarCommandTarget

If the tool window has a ToolBar, then you can use this property to customize its command target. If this value is null, then the window frame of this tool window is used as the command target for the ToolBar. Like other toolbar-related properties, this property must be set before the initialization of the ToolWindowPane is complete.

System_CAPS_pubpropertyToolBarDropTarget

Gets or sets the toolbar drop target.

System_CAPS_pubpropertyToolBarLocation

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

System_CAPS_pubpropertyToolClsid

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

System_CAPS_pubpropertyWindow

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

NameDescription
System_CAPS_pubmethodAddInfoBar(IVsInfoBar)

Adds an info bar to this ToolWindowPane. The info bar will show at the top of the pane's frame when that frame is visible on screen.

System_CAPS_pubmethodAddInfoBar(IVsUIElement)

Adds an info bar to this ToolWindowPane. The info bar will show at the top of the pane's frame when that frame is visible on screen.

System_CAPS_pubmethodClearSearch()

Clears the pane of the results from a previously completed or partial search.

System_CAPS_pubmethodCreateSearch(UInt32, IVsSearchQuery, IVsSearchCallback)

Override at least this function if you need to support search in a tool window.

System_CAPS_pubmethodDispose()

Disposes the window pane and its resources.(Inherited from WindowPane.)

System_CAPS_protmethodDispose(Boolean)

Disposes the resources of the window pane.(Inherited from WindowPane.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetIVsWindowPane()

Gets the IVsWindowPane that is associated with the tool window.

System_CAPS_protmethodGetService(Type)

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

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodInitialize()

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

System_CAPS_pubmethodLoadUIState(Stream)

Override to load the previously saved state of the pane. (Inherited from WindowPane.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnClose()

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

System_CAPS_protmethodOnCreate()

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

System_CAPS_protmethodOnInfoBarActionItemClicked(IVsInfoBarUIElement, IVsInfoBar, IVsInfoBarActionItem)

Called when an action item on an info bar added via AddInfoBar is clicked. If this method is overridden, the base implementation must be called to raise the InfoBarActionItemClicked event.

System_CAPS_protmethodOnInfoBarClosed(IVsInfoBarUIElement, IVsInfoBar)

Called when an info bar added via AddInfoBar is closed. If this method is overridden,the base implementation must be called to raise the InfoBarClosed event.

System_CAPS_pubmethodOnNavigationKeyDown(UInt32, UInt32)

Allows the pane to intercept certain keys after a search is started, and to navigate between the results or select one of the results displayed in the pane.

System_CAPS_pubmethodOnToolBarAdded()

Called when a toolbar is added to the tool window.

System_CAPS_pubmethodOnToolWindowCreated()

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

System_CAPS_protmethodPreProcessMessage(Message)

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

System_CAPS_pubmethodProvideSearchSettings(IVsUIDataSource)

Allows override of default search settings. By default, the search is started delayed, with indefinite progress. The names of properties that can be overridden are defined in the class SearchSettingsDataSource.PropertyNames. Values that implement the IVsUIObject interface can be constructed for common types using the BuiltInPropertyValue class, or you could use helper functions like SetValue to set values in the data source.

System_CAPS_pubmethodRemoveInfoBar(IVsInfoBar)

Removes an info bar from this ToolWindowPane.

System_CAPS_pubmethodRemoveInfoBar(IVsUIElement)

Removes an info bar from this ToolWindowPane.

System_CAPS_pubmethodSaveUIState(Stream)

Override to save custom state information to be used later when the pane is reconstructed.(Inherited from WindowPane.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventInfoBarActionItemClicked

Event raised when a button or hyperlink on an info bar associated with this ToolWindowPane.

System_CAPS_pubeventInfoBarClosed

Event raised when an info bar associated with this ToolWindowPane is closed.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)

Executes the specified command.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleCommandTarget.QueryStatus(Guid, UInt32, OLECMD[], IntPtr)

Gets the status of the commands.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUIElementPane.CloseUIElementPane()

Closes the pane.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUIElementPane.CreateUIElementPane(Object)

Creates the pane.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUIElementPane.GetDefaultUIElementSize(SIZE[])

When implemented in a derived class, gets the default size of the pane. (Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUIElementPane.LoadUIElementState(IStream)

When implemented in a derived class, loads custom state storage.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUIElementPane.SaveUIElementState(IStream)

Stores the state of the pane to the specified stream.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUIElementPane.SetUIElementSite(IServiceProvider)

Sets the site for this window pane.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsUIElementPane.TranslateUIElementAccelerator(MSG[])

Handles keyboard accelerators before the shell processes the message.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsWindowPane.ClosePane()

Obsolete.Closes the window pane. Obsolete.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsWindowPane.CreatePaneWindow(IntPtr, Int32, Int32, Int32, Int32, IntPtr)

Obsolete.Creates a window pane. Obsolete.(Inherited from WindowPane.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsWindowPane.GetDefaultSize(SIZE[])

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsWindowPane.LoadViewState(IStream)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsWindowPane.SaveViewState(IStream)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsWindowPane.SetSite(IServiceProvider)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsWindowPane.TranslateAccelerator(MSG[])

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIServiceProvider.GetService(Type)

Gets the service of the specified type.(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.

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

Return to top
Show: