Share via


ModelingWindowPane Class

Provides selection service and selection event notification for both tool windows and document views.

This API is not CLS-compliant. 

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Shell.WindowPane
    Microsoft.VisualStudio.Modeling.Shell.ModelingWindowPane
      Microsoft.VisualStudio.Modeling.Shell.ModelingDocView
      Microsoft.VisualStudio.Modeling.Shell.ToolWindow

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class ModelingWindowPane _
    Inherits WindowPane _
    Implements IObjectWithSite, ISelectionContainer, ISelectionService
[CLSCompliantAttribute(false)]
public abstract class ModelingWindowPane : WindowPane, 
    IObjectWithSite, ISelectionContainer, ISelectionService
[CLSCompliantAttribute(false)]
public ref class ModelingWindowPane abstract : public WindowPane, 
    IObjectWithSite, ISelectionContainer, ISelectionService
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type ModelingWindowPane =  
    class 
        inherit WindowPane 
        interface IObjectWithSite 
        interface ISelectionContainer 
        interface ISelectionService 
    end
public abstract class ModelingWindowPane extends WindowPane implements IObjectWithSite, ISelectionContainer, ISelectionService

The ModelingWindowPane type exposes the following members.

Constructors

  Name Description
Protected method ModelingWindowPane Initializes a new instance of the ModelingWindowPane class with the specified IServiceProvider.

Top

Properties

  Name Description
Public property ActiveInPlaceEditWindow Gets and sets the active window for in-place editing.
Public property Content (Inherited from WindowPane.)
Public property Frame Gets the IVsWindowFrame that corresponds to this window..
Protected property HasSelectableObjects Returns whether this window pane has objects that can be selected.
Protected property HelpService Gets the help service.
Protected property InitializationMode (Inherited from WindowPane.)
Public property MenuService Gets the menu command service.
Public property PrimarySelection Gets the primary selected element in the window pane.
Protected property SelectedElements Gets the elements that are selected in the window pane.
Public property SelectionCount Gets the number of elements that are selected in the window pane.
Protected property SelectionHelpService Gets the selection help service.
Protected property ServiceProvider Gets the service provider that is local to this window pane.
Public property Window (Inherited from WindowPane.)

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.
Protected method CountAllObjects Gets the number of elements in the window pane.
Public method CountObjects Counts the number of elements in the window pane or in the current selection.
Protected method CountSelectedObjects Gets the number of elements in the current selection.
Public method Dispose() (Inherited from WindowPane.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the ModelingWindowPane and optionally releases the managed resources. (Overrides WindowPane.Dispose(Boolean).)
Protected method DoSelectObjects When implemented in a derived class, selects elements in the window pane.
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.
Public method GetComponentSelected Specifies whether the given component is selected.
Public method GetContainerSelected Specifies whether the given container is selected.
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.
Public method GetSelectedComponents Gets the components that are selected in the window pane.
Protected method GetSelectedObjects Gets the elements that are selected in the window pane.
Protected method GetService Gets the service of the specified type. Override this method to return the custom menu command service (Overrides WindowPane.GetService(Type).)
Public method GetSite Gets the site that was set with SetSite.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Hide Hides the window pane.
Protected method Initialize (Inherited from WindowPane.)
Public method LoadUIState (Inherited from WindowPane.)
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. (Overrides WindowPane.OnClose().)
Protected method OnCreate (Inherited from WindowPane.)
Protected method OnSelectionChanged Notifies event listeners after the selection changes.
Protected method OnSelectionChanging Notifies event listeners before the selection changes.
Protected method PreProcessMessage Handles window messages. (Overrides WindowPane.PreProcessMessage(Message%).)
Public method SaveUIState (Inherited from WindowPane.)
Public method SelectObjects Selects elements in the window pane.
Public method SetSelectedComponents(ICollection) Adds the specified components into the selection container and notifies the shell of the selection change.
Public method SetSelectedComponents(ICollection, SelectionTypes) Not currently implemented.
Public method SetSite Initializes the window pane in the environment.
Public method Show Displays the window pane, brings it to the front, and makes it the active window.
Public method ShowNoActivate Displays the window pane, brings it to the front, but does not make it the active window.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event SelectionChanged Fired after the selection in the window pane has changed.
Public event SelectionChanging Fired before the selection in the window pane changes.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IVsWindowPane.ClosePane Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsUIElementPane.CloseUIElementPane (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsWindowPane.CreatePaneWindow Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsUIElementPane.CreateUIElementPane (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IOleCommandTarget.Exec (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsWindowPane.GetDefaultSize Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsUIElementPane.GetDefaultUIElementSize (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IServiceProvider.GetService (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsUIElementPane.LoadUIElementState (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsWindowPane.LoadViewState Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IOleCommandTarget.QueryStatus (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsUIElementPane.SaveUIElementState (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsWindowPane.SaveViewState Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsWindowPane.SetSite Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsUIElementPane.SetUIElementSite (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsWindowPane.TranslateAccelerator Obsolete. (Inherited from WindowPane.)
Explicit interface implemetationPrivate method IVsUIElementPane.TranslateUIElementAccelerator (Inherited from WindowPane.)

Top

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.

See Also

Reference

Microsoft.VisualStudio.Modeling.Shell Namespace