ModelingWindowPane Class

Article
02/04/2013

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

This API is not CLS-compliant.

Inheritance Hierarchy

System.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.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.10.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
	ModelingWindowPane	Initializes a new instance of the ModelingWindowPane class with the specified IServiceProvider.

Top

Properties

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

Top

Methods

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

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

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.

Share via