ModelExplorerToolWindow Class
Represents the tool window, which hosts Model Explorer.
This API is not CLS-compliant.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Shell.WindowPane
Microsoft.VisualStudio.Modeling.Shell.ModelingWindowPane
Microsoft.VisualStudio.Modeling.Shell.ToolWindow
Microsoft.VisualStudio.Modeling.Shell.ModelExplorerToolWindow
Namespace: Microsoft.VisualStudio.Modeling.Shell
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Shell.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.10.0.dll)
Syntax
'Declaração
<CLSCompliantAttribute(False)> _
Public MustInherit Class ModelExplorerToolWindow _
Inherits ToolWindow
[CLSCompliantAttribute(false)]
public abstract class ModelExplorerToolWindow : ToolWindow
[CLSCompliantAttribute(false)]
public ref class ModelExplorerToolWindow abstract : public ToolWindow
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type ModelExplorerToolWindow =
class
inherit ToolWindow
end
public abstract class ModelExplorerToolWindow extends ToolWindow
The ModelExplorerToolWindow type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ModelExplorerToolWindow | Initializes a new instance of the ModelExplorerToolWindow class. |
Top
Properties
Name | Description | |
---|---|---|
ActiveInPlaceEditWindow | Gets and sets the active window for in-place editing. (Inherited from ModelingWindowPane.) | |
BitmapIndex | When overriden in a derived class, gets the index of the bitmap that appears next to the name of the tool window. (Inherited from ToolWindow.) | |
BitmapResource | When overriden in a derived class, gets the resource ID of the bitmap that appears next to the name of the tool window. (Inherited from ToolWindow.) | |
Content | (Inherited from WindowPane.) | |
DocData | Gets a document in memory. (Inherited from ToolWindow.) | |
EnableUndo | Gets the undo operation and verifies whether it is enabled for the tool window. (Overrides ToolWindow.EnableUndo.) | |
Frame | Gets the IVsWindowFrame that corresponds to this window.. (Inherited from ModelingWindowPane.) | |
HasSelectableObjects | Gets the tool window disables the Select Objects command if a document is not loaded. (Inherited from ToolWindow.) | |
HasToolBar | Gets the tool window and verifies whether it should have a toolbar. (Inherited from ToolWindow.) | |
HelpService | Gets the help service. (Inherited from ModelingWindowPane.) | |
InitializationMode | (Inherited from WindowPane.) | |
MenuService | Gets the menu command service. (Inherited from ModelingWindowPane.) | |
PrimarySelection | Gets the primary selected element in the window pane. (Inherited from ModelingWindowPane.) | |
SelectedElements | Gets the elements that are selected in the window pane. (Inherited from ModelingWindowPane.) | |
SelectionCount | Gets the number of elements that are selected in the window pane. (Inherited from ModelingWindowPane.) | |
SelectionHelpService | Gets the selection help service. (Inherited from ModelingWindowPane.) | |
ServiceProvider | Gets the service provider that is local to this window pane. (Inherited from ModelingWindowPane.) | |
ToolBarHost | Gets the IVsToolWindowToolbarHost interface, which determines how toolbars appear in the tool window. (Inherited from ToolWindow.) | |
ToolWindowFont | Gets the font to use for the tool window. (Inherited from ToolWindow.) | |
TreeContainer | Gets the container for the navigation tree in Model Explorer. | |
Window | Gets the Model Explorer window. (Overrides WindowPane.Window.) | |
WindowTitle | Gets the title of the Model Explorer window. (Overrides ToolWindow.WindowTitle.) |
Top
Methods
Name | Description | |
---|---|---|
CommitPendingEditForCommand | When implemented in a derived class, specifies whether pending edits should be committed before a command is executed. (Inherited from ModelingWindowPane.) | |
CountAllObjects | Gets the number of elements in the window pane. (Inherited from ModelingWindowPane.) | |
CountObjects | Counts the number of elements in the window pane or in the current selection. (Inherited from ModelingWindowPane.) | |
CountSelectedObjects | Gets the number of elements in the current selection. (Inherited from ModelingWindowPane.) | |
CreateTreeContainer | Creates the container for the navigation tree in Model Explorer. | |
Dispose() | (Inherited from WindowPane.) | |
Dispose(Boolean) | Releases the unmanaged resources used by the ModelExplorerToolWindow and optionally releases the managed resources. (Overrides ToolWindow.Dispose(Boolean).) | |
DoSelectObjects | When implemented in a derived class, selects elements in the window pane. (Inherited from ModelingWindowPane.) | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetAllObjects | Gets all elements in the window pane. (Inherited from ModelingWindowPane.) | |
GetComponentSelected | Specifies whether the given component is selected. (Inherited from ModelingWindowPane.) | |
GetContainerSelected | Specifies whether the given container is selected. (Inherited from ModelingWindowPane.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetObjects | Gets either the elements that are currently selected or the elements that can be selected in the window pane. (Inherited from ModelingWindowPane.) | |
GetSelectedComponents | Gets the components that are selected in the window pane. (Inherited from ModelingWindowPane.) | |
GetSelectedObjects | Gets the elements that are selected in the window pane. (Inherited from ModelingWindowPane.) | |
GetService | Gets the service of the specified type. Override this method to return the custom menu command service (Inherited from ModelingWindowPane.) | |
GetSite | Gets the site that was set with SetSite. (Inherited from ModelingWindowPane.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Hide | Hides the window pane. (Inherited from ModelingWindowPane.) | |
Initialize | Initializes a new instance of the ToolWindow class. (Inherited from ToolWindow.) | |
LoadUIState | (Inherited from WindowPane.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnAfterToolWindowCreate | Post-creation initialization. (Inherited from ToolWindow.) | |
OnClose | Removes window pane objects from the shortcut menu selection when the window pane is closed. (Inherited from ModelingWindowPane.) | |
OnCreate | Creates a tool window. (Inherited from ToolWindow.) | |
OnDocumentWindowChanged | Notifies derived classes if a change is made in the document window. (Overrides ToolWindow.OnDocumentWindowChanged(ModelingDocView, ModelingDocView).) | |
OnSelectionChanged | Notifies event listeners after the selection changes. (Inherited from ModelingWindowPane.) | |
OnSelectionChanging | Notifies event listeners before the selection changes. (Inherited from ModelingWindowPane.) | |
OnToolWindowCreate | Listens for frame changes in a document window. (Overrides ToolWindow.OnToolWindowCreate().) | |
PreProcessMessage | Handles window messages. (Inherited from ModelingWindowPane.) | |
SaveUIState | (Inherited from WindowPane.) | |
SelectObjects | Selects elements in the window pane. (Inherited from ModelingWindowPane.) | |
SetSelectedComponents(ICollection) | Adds the specified components into the selection container and notifies the shell of the selection change. (Inherited from ModelingWindowPane.) | |
SetSelectedComponents(ICollection, SelectionTypes) | Not currently implemented. (Inherited from ModelingWindowPane.) | |
SetSite | Initializes the window pane in the environment. (Inherited from ModelingWindowPane.) | |
Show | Displays the window pane, brings it to the front, and makes it the active window. (Inherited from ModelingWindowPane.) | |
ShowNoActivate | Displays the window pane, brings it to the front, but does not make it the active window. (Inherited from ModelingWindowPane.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
Name | Description | |
---|---|---|
SelectionChanged | Fired after the selection in the window pane has changed. (Inherited from ModelingWindowPane.) | |
SelectionChanging | Fired before the selection in the window pane changes. (Inherited from ModelingWindowPane.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IVsWindowPane.ClosePane | Obsolete. (Inherited from WindowPane.) | |
IVsUIElementPane.CloseUIElementPane | (Inherited from WindowPane.) | |
IVsWindowPane.CreatePaneWindow | Obsolete. (Inherited from WindowPane.) | |
IVsUIElementPane.CreateUIElementPane | (Inherited from WindowPane.) | |
IOleCommandTarget.Exec | (Inherited from WindowPane.) | |
IVsWindowPane.GetDefaultSize | Obsolete. (Inherited from WindowPane.) | |
IVsUIElementPane.GetDefaultUIElementSize | (Inherited from WindowPane.) | |
IServiceProvider.GetService | (Inherited from WindowPane.) | |
IVsUIElementPane.LoadUIElementState | (Inherited from WindowPane.) | |
IVsWindowPane.LoadViewState | Obsolete. (Inherited from WindowPane.) | |
IOleCommandTarget.QueryStatus | (Inherited from WindowPane.) | |
IVsUIElementPane.SaveUIElementState | (Inherited from WindowPane.) | |
IVsWindowPane.SaveViewState | Obsolete. (Inherited from WindowPane.) | |
IVsWindowPane.SetSite | Obsolete. (Inherited from WindowPane.) | |
IVsUIElementPane.SetUIElementSite | (Inherited from WindowPane.) | |
IVsWindowPane.TranslateAccelerator | Obsolete. (Inherited from WindowPane.) | |
IVsUIElementPane.TranslateUIElementAccelerator | (Inherited from WindowPane.) |
Top
Remarks
Before you can add a tool window to the generated designer, you must register the window. For more information, see ModelingPackage.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.