Share via


ToolWindow Members

Include Protected Members
Include Inherited Members

When overridden by a derived class, represents a tool window in the generated designer for a domain-specific language.

The ToolWindow type exposes the following members.

Constructors

 

Name

Description

Protected method

ToolWindow

Initializes a new instance of the ToolWindow class.

Top

Methods

 

Name

Description

Protected method

CommitPendingEditForCommand

When implemented in a derived class, specifies whether pending edits should be committed before a command is executed. (Inherited from ModelingWindowPane.)

Protected method

CountAllObjects

Gets the number of elements in the window pane. (Inherited from ModelingWindowPane.)

Public method

CountObjects

Counts the number of elements in the window pane or in the current selection. (Inherited from ModelingWindowPane.)

Protected method

CountSelectedObjects

Gets the number of elements in the current selection. (Inherited from ModelingWindowPane.)

Public method

Dispose

Overloaded.

Protected method

DoSelectObjects

When implemented in a derived class, selects elements in the window pane. (Inherited from ModelingWindowPane.)

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.)

Protected method

GetAllObjects

Gets all elements in the window pane. (Inherited from ModelingWindowPane.)

Public method

GetComponentSelected

Specifies whether the given component is selected. (Inherited from ModelingWindowPane.)

Public method

GetContainerSelected

Specifies whether the given container is selected. (Inherited from ModelingWindowPane.)

Public method

GetHashCode

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

Public method

GetObjects

Gets either the elements that are currently selected or the elements that can be selected in the window pane. (Inherited from ModelingWindowPane.)

Public method

GetSelectedComponents

Gets the components that are selected in the window pane. (Inherited from ModelingWindowPane.)

Protected method

GetSelectedObjects

Gets the elements that are selected in the window pane. (Inherited from ModelingWindowPane.)

Protected method

GetService

Gets the service of the specified type. Override this method to return the custom menu command service (Inherited from ModelingWindowPane.)

Public method

GetSite

Gets the site that was set with SetSite. (Inherited from ModelingWindowPane.)

Public method

GetType

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

Public method

Hide

Hides the window pane. (Inherited from ModelingWindowPane.)

Protected method

Initialize

Initializes a new instance of the ToolWindow class. (Overrides WindowPane.Initialize().)

Protected method

MemberwiseClone

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

Protected method

OnClose

Removes window pane objects from the shortcut menu selection when the window pane is closed. (Inherited from ModelingWindowPane.)

Protected method

OnCreate

Creates a tool window. (Overrides WindowPane.OnCreate().)

Protected method

OnDocumentWindowChanged

Notifies derived classes if a user makes a change in the document window.

Protected method

OnSelectionChanged

Notifies event listeners after the selection changes. (Inherited from ModelingWindowPane.)

Protected method

OnSelectionChanging

Notifies event listeners before the selection changes. (Inherited from ModelingWindowPane.)

Protected method

OnToolWindowCreate

Listens for frame changes in a document window

Protected method

PreProcessMessage

Handles window messages. (Inherited from ModelingWindowPane.)

Public method

SelectObjects

Selects elements in the window pane. (Inherited from ModelingWindowPane.)

Public method

SetSelectedComponents

Overloaded. Puts the selected components into the selection container and replaces the currently-selected components, and notifies the shell of the change.

Public method

SetSite

Initializes the window pane in the environment. (Inherited from ModelingWindowPane.)

Public method

Show

Displays the window pane, brings it to the front, and makes it the active window. (Inherited from ModelingWindowPane.)

Public method

ShowNoActivate

Displays the window pane, brings it to the front, but does not make it the active window. (Inherited from ModelingWindowPane.)

Public method

ToString

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

Top

Properties

 

Name

Description

Public property

ActiveInPlaceEditWindow

Gets and sets the active window for in-place editing. (Inherited from ModelingWindowPane.)

Protected property

BitmapIndex

When overriden in a derived class, gets the index of the bitmap that appears next to the name of the tool window.

Protected property

BitmapResource

When overriden in a derived class, gets the resource ID of the bitmap that appears next to the name of the tool window.

Public property

DocData

Gets a document in memory.

Protected property

EnableUndo

Gets the tool window and enables the Undo command.

Public property

Frame

Gets the IVsWindowFrame that corresponds to this window.. (Inherited from ModelingWindowPane.)

Protected property

HasSelectableObjects

Gets the tool window disables the Select Objects command if a document is not loaded. (Overrides ModelingWindowPane.HasSelectableObjects.)

Protected property

HasToolBar

Gets the tool window and verifies whether it should have a toolbar.

Protected property

HelpService

Gets the help service. (Inherited from ModelingWindowPane.)

Public property

MenuService

Gets the menu command service. (Inherited from ModelingWindowPane.)

Public property

PrimarySelection

Gets the primary selected element in the window pane. (Inherited from ModelingWindowPane.)

Protected property

SelectedElements

Gets the elements that are selected in the window pane. (Inherited from ModelingWindowPane.)

Public property

SelectionCount

Gets the number of elements that are selected in the window pane. (Inherited from ModelingWindowPane.)

Protected property

SelectionHelpService

Gets the selection help service. (Inherited from ModelingWindowPane.)

Protected property

ServiceProvider

Gets the service provider that is local to this window pane. (Inherited from ModelingWindowPane.)

Protected property

ToolBarHost

Gets the IVsToolWindowToolbarHost interface, which determines how toolbars appear in the tool window.

Protected property

ToolWindowFont

Gets the font to use for the tool window.

Public property

Window

(Inherited from WindowPane.)

Public property

WindowTitle

Gets the title of the tool window.

Top

Events

 

Name

Description

Public event

SelectionChanged

Fired after the selection in the window pane has changed. (Inherited from ModelingWindowPane.)

Public event

SelectionChanging

Fired before the selection in the window pane changes. (Inherited from ModelingWindowPane.)

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate method

IVsWindowPane.ClosePane

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.CreatePaneWindow

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IOleCommandTarget.Exec

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.GetDefaultSize

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IServiceProvider.GetService

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.LoadViewState

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsBroadcastMessageEvents.OnBroadcastMessage

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IOleCommandTarget.QueryStatus

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.SaveViewState

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.SetSite

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.TranslateAccelerator

(Inherited from WindowPane.)

Top

See Also

Reference

ToolWindow Class

Microsoft.VisualStudio.Modeling.Shell Namespace