ToolWindow Class

Construct a tool window.

May be set to provide an active in-place edit window Clipboard commands will be routed to this window.

Overriden in derived classes to specify the index of the bitmap to display next to the tool window name in tabbed mode. This must be an index into the image resource specified by the BitmapResource property.

Overriden in derived classes to specify the resource id of the bitmap to display next to the tool window name in tabbed mode. This must be an index into the unmanaged satellite dll corresponding to this package. If -1 is returned, the toolwindow is considered to not have a Bitmap. b409435

Gets or sets the content of this tool window.

Gets the currently focused document data. This will be null if this is not an instance of our DocData object.

Used by derived classes to turn on/off handling of undo commands.

Provides access to the IVsWindowFrame corresponding to this window. In most cases, direct access to this interface is not necessary

Overridden here to return false when the document we are tracking is closed.

Overriden in derived classes that want to host a toolbar. Placement and toolbar to display should be set in the derived class via the ToolbarHost.

Help context managed by this window. Keywords and attributes placed in this context will have priority HelpContextType.Window.

Gets the initialization mode that is associated with this window pane.

Gets the IMenuCommandService which derived classes and hosted controls can use to add commands.

Returns the current primary selection. If one hasn't been set, returns the first object in the collection

Stores the elements currently selected in this window.

A count of the currently selected objects.

Help context managed by this window. Help keywords and attributes placed in this context have priority HelpContextType.Selection for document windows and HelpContextType.ToolWindowSelection for tool windows. The context is cleared on each selection change, so derived class that use this context should override OnSelectionChanged to keep it up-to-date.

Gets the service provider local to this window frame

Provides derived classes access to the shell implementation of IVsToolWindowToolbarHost, used to manage toolbars in the the tool window.

Returns the font used by the VS shell for dialog boxes and tool windows.

Gets the window associated with this window pane.

Overriden in derived classes to specify title for the tool window.

Gives derived classes a chance to commit outstanding edits before a command is executed. This is called frequently, so only lightweight processing should be done here. This is preferable to IVsWindowPaneCommit.CommitPendingEdit, because it allows derived classes to make the decision to commit for some commands but not others.

mplementation of ISelectionContainer interface.

Implementation of ISelectionContainer interface.

Implementation of ISelectionContainer interface.

Disposes the window pane and its resources.

Dispose of resources.

Derived classes should override to support selection via ISelectionContainer.SelectObjects. For instance, The drop-down above the VS property browser uses this mechanism, as does automation.

ISelectionContainer.GetObjects (All).

Returns true iff obj is currently selected.

Implementation identical to GetComponentSelected.

Implementation of ISelectionContainer interface.

Returns a read-only collection of currently selected components.

ISelectionContainer.GetObjects (Selected).

Override to return our menu command service implementation.

Implementation of IObjectWithSite.

Hides this window.

Perform initializaton. ToolWindow base class set frame properties here.

Override to load previously saved state of the pane

Post-creation initialization.

Called when window is closed. Overridden here to remove our objects from the selection context so that the property browser doesn't call back on our objects after the window is closed.

Called when the ToolWindow is created.

Derived classes can override this to receive notification when the document window changes in the shell. The new view is stored in the CurrentView property.

Called when the selection changes. Derived classes that override this method should make sure to call the base class so event listeners are notified.

Called prior to a selection change. Derived classes that override this method should make sure to call the base class so event listeners are notified.

Called when the ToolWindow is created.

Allows us to handle window messages.

Override to save custom state information to be used later when the pane is reconstructed.

Implementation of ISelectionContainer interface.

Not used. Implemenation of ISelectionService interface.

Pushes components into the selection container (replaces currently selected components), and notifies the shell of a selection change.

Implementation of IObjectWithSite.

Shows this window.

Shows this window without activating it.

This event gets fired after a selection change in this window. Clients that want notification of selection changes to this window should register an event handler.

This event gets fired just prior to a selection change in this window. Clients that want notification of selection changes to this window should register an event handler.

Executes the specified command.

Gets the status of the commands.

Gets the service of the specified type.

Closes the pane.

Creates the pane.

When implemented in a derived class, gets the default size of the pane.

When implemented in a derived class, loads custom state storage.

Stores the state of the pane to the specified stream.

Sets the site for this window pane.

Handles keyboard accelerators before the shell processes the message.

Closes the window pane. Obsolete.

Creates a window pane. Obsolete.

Gets the default size of the window pane. Obsolete.

Loads the saved view state. Obsolete.

Saves the loaded view state. Obsolete.

Initializes this window pane with the specified service provider. Obsolete.

Handles the translation of navigation keys. Obsolete