ToolWindow 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 Verifies whether outstanding edits should be committed before a command is executed. (Inherited from ModelingWindowPane.)
Protected method CountAllObjects Counts the number of elements in the modeling window. (Inherited from ModelingWindowPane.)
Public method CountObjects Counts the number of elements in the modeling window or in the current selection. (Inherited from ModelingWindowPane.)
Protected method CountSelectedObjects Counts the number of elements in the current selection. (Inherited from ModelingWindowPane.)
Public method Dispose Overloaded.
Protected method DoSelectObjects Selects elements in the modeling window. (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 attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetAllObjects Gets all elements in the modeling window. (Inherited from ModelingWindowPane.)
Public method GetComponentSelected Verifies whether the specified element is selected. (Inherited from ModelingWindowPane.)
Public method GetContainerSelected Verifies whether the specified container is selected. (Inherited from ModelingWindowPane.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetObjects Returns either the elements that are selected or the elements that can be selected in the modeling window. (Inherited from ModelingWindowPane.)
Public method GetSelectedComponents Gets a read-only collection of elements that are selected in the modeling window. (Inherited from ModelingWindowPane.)
Protected method GetSelectedObjects Returns the elements that are selected in the modeling window. (Inherited from ModelingWindowPane.)
Protected method GetService Gets the menu command service that you want to implement. (Inherited from ModelingWindowPane.)
Public method GetSite Retrieves the site that was set most recently with SetSite. If no site is known, a failure code is returned. (Inherited from ModelingWindowPane.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Hide Hides the modeling window. (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 modeling window objects from the shortcut menu selection when the modeling window 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 from the base class when the selection changes. (Inherited from ModelingWindowPane.)
Protected method OnSelectionChanging Notifies event listeners from the base class before the selection changes. (Inherited from ModelingWindowPane.)
Protected method OnToolWindowCreate Listens for frame changes in a document window
Protected method PreProcessMessage Verifies whether Windows sent a message. (Inherited from ModelingWindowPane.)
Public method SelectObjects Selects elements in the modeling window. (Inherited from ModelingWindowPane.)
Public method SetSelectedComponents Overloaded.
Public method SetSite Initializes the modeling window in the environment. (Inherited from ModelingWindowPane.)
Public method Show Displays the modeling window, brings it to the top, and makes it the active window. (Inherited from ModelingWindowPane.)
Public method ShowNoActivate Displays the modeling window, brings it to the top, 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 access to behavior and properties of the modeling window interface for both tool and document windows. (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 support for Help topics, including adding and subtracting Help keywords. (Inherited from ModelingWindowPane.)
Public property MenuService Gets support to manage the global designer verbs, menu commands, and shortcut menus for the modeling window. (Inherited from ModelingWindowPane.)
Public property PrimarySelection Gets the primary selected element in the modeling window. If the window contains no primary element, the first element that was selected becomes the primary element. (Inherited from ModelingWindowPane.)
Protected property SelectedElements Gets the elements that are selected in the modeling window. (Inherited from ModelingWindowPane.)
Public property SelectionCount Gets the number of elements that are selected in the modeling window. (Inherited from ModelingWindowPane.)
Protected property SelectionHelpService Gets support for displaying Help topics and adding and removing Help keywords for the elements that are selected. (Inherited from ModelingWindowPane.)
Protected property ServiceProvider Gets the service provider that is local to the modeling window. (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 Occurs when the selection in the modeling window has changed. (Inherited from ModelingWindowPane.)
Public event SelectionChanging Occurs when the selection in the modeling window is about to change. (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