ModelingWindowPane Class

Definition

Namespace:

Microsoft.VisualStudio.Modeling.Shell

Assembly:

Microsoft.VisualStudio.Modeling.Sdk.Shell.dll

Package:

Microsoft.VisualStudio.Modeling.Sdk.Shell v17.10.40171

Important

This API is not CLS-compliant.

Contains glue for hosting Modeling-based designers in the shell that applies to both tool windows and document views.

public ref class ModelingWindowPane abstract : Microsoft::VisualStudio::Shell::WindowPane, Microsoft::VisualStudio::OLE::Interop::IObjectWithSite, Microsoft::VisualStudio::Shell::Interop::ISelectionContainer, System::ComponentModel::Design::ISelectionService

public abstract class ModelingWindowPane : Microsoft.VisualStudio.Shell.WindowPane, Microsoft.VisualStudio.OLE.Interop.IObjectWithSite, Microsoft.VisualStudio.Shell.Interop.ISelectionContainer, System.ComponentModel.Design.ISelectionService

type ModelingWindowPane = class
    inherit WindowPane
    interface IObjectWithSite
    interface ISelectionContainer
    interface ISelectionService

Public MustInherit Class ModelingWindowPane
Inherits WindowPane
Implements IObjectWithSite, ISelectionContainer, ISelectionService

Inheritance

Object

WindowPane

ModelingWindowPane

Derived

Microsoft.VisualStudio.Modeling.Shell.ModelingDocView

Microsoft.VisualStudio.Modeling.Shell.ToolWindow

Implements

IObjectWithSite ISelectionContainer ISelectionService

Constructors

ModelingWindowPane(IServiceProvider)

Properties

ActiveInPlaceEditWindow	May be set to provide an active in-place edit window Clipboard commands will be routed to this window.
Content	Gets or sets the content of this tool window. (Inherited from WindowPane)
Frame	Provides access to the IVsWindowFrame corresponding to this window. In most cases, direct access to this interface is not necessary
HasSelectableObjects	If this property returns false, we do not expose objects via ISelectionContainer to avoid handing out disposed objects to the property browser. Base class returns true. Can be overridden in derived classes to return false when a document or window is closed.
HelpService	Help context managed by this window. Keywords and attributes placed in this context will have priority HelpContextType.Window.
InitializationMode	Gets the initialization mode that is associated with this window pane. (Inherited from WindowPane)
MenuService	Gets the IMenuCommandService which derived classes and hosted controls can use to add commands.
ParentHandle	(Inherited from WindowPane)
PrimarySelection	Returns the current primary selection. If one hasn't been set, returns the first object in the collection
SelectedElements	Stores the elements currently selected in this window.
SelectionCount	A count of the currently selected objects.
SelectionHelpService	Help context managed by this window. Help keywords and attributes placed in this context have priority HelpContextType.Selection for document windows and HelpContextType.ToolWindowSelection for tool windows. The context is cleared on each selection change, so derived class that use this context should override OnSelectionChanged to keep it up-to-date.
ServiceProvider	Gets the service provider local to this window frame
Window	Gets the window associated with this window pane. (Inherited from WindowPane)

Methods

CommitPendingEditForCommand(CommandID)	Gives derived classes a chance to commit outstanding edits before a command is executed. This is called frequently, so only lightweight processing should be done here. This is preferable to IVsWindowPaneCommit.CommitPendingEdit, because it allows derived classes to make the decision to commit for some commands but not others.
CountAllObjects()	mplementation of ISelectionContainer interface.
CountObjects(UInt32, UInt32)	Implementation of ISelectionContainer interface.
CountSelectedObjects()	Implementation of ISelectionContainer interface.
Dispose()	Disposes the window pane and its resources. (Inherited from WindowPane)
Dispose(Boolean)	Dispose of resources
DoSelectObjects(UInt32, Object[], UInt32)	Derived classes should override to support selection via ISelectionContainer.SelectObjects. For instance, The drop-down above the VS property browser uses this mechanism, as does automation.
GetAllObjects(UInt32, Object[])	ISelectionContainer.GetObjects (All).
GetComponentSelected(Object)	Returns true iff obj is currently selected.
GetContainerSelected(Object)	Implementation identical to GetComponentSelected.
GetObjects(UInt32, UInt32, Object[])	Implementation of ISelectionContainer interface.
GetSelectedComponents()	Returns a read-only collection of currently selected components.
GetSelectedObjects(UInt32, Object[])	ISelectionContainer.GetObjects (Selected).
GetService(Type)	Override to return our menu command service implementation.
GetSite(Guid, IntPtr)	Implementation of IObjectWithSite.
Hide()	Hides this window.
Initialize()	Initializes services after the window pane has been sited. (Inherited from WindowPane)
LoadUIState(Stream)	Override to load previously saved state of the pane (Inherited from WindowPane)
OnClose()	Called when window is closed. Overridden here to remove our objects from the selection context so that the property browser doesn't call back on our objects after the window is closed.
OnCreate()	Raised when the window pane is created. (Inherited from WindowPane)
OnSelectionChanged(EventArgs)	Called when the selection changes. Derived classes that override this method should make sure to call the base class so event listeners are notified.
OnSelectionChanging(EventArgs)	Called prior to a selection change. Derived classes that override this method should make sure to call the base class so event listeners are notified.
PreProcessMessage(Message)	Allows us to handle window messages.
SaveUIState(Stream)	Override to save custom state information to be used later when the pane is reconstructed. (Inherited from WindowPane)
SelectObjects(UInt32, Object[], UInt32)	Implementation of ISelectionContainer interface.
SetSelectedComponents(ICollection, SelectionTypes)	Not used. Implemenation of ISelectionService interface.
SetSelectedComponents(ICollection)	Pushes components into the selection container (replaces currently selected components), and notifies the shell of a selection change.
SetSite(Object)	Implementation of IObjectWithSite.
Show()	Shows this window.
ShowNoActivate()	Shows this window without activating it.

Events

SelectionChanged	This event gets fired after a selection change in this window. Clients that want notification of selection changes to this window should register an event handler.
SelectionChanging	This event gets fired just prior to a selection change in this window. Clients that want notification of selection changes to this window should register an event handler.

Explicit Interface Implementations

IOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)	Executes the specified command. (Inherited from WindowPane)
IOleCommandTarget.QueryStatus(Guid, UInt32, OLECMD[], IntPtr)	Gets the status of the commands. (Inherited from WindowPane)
IServiceProvider.GetService(Type)	Gets the service of the specified type. (Inherited from WindowPane)
IVsUIElementPane.CloseUIElementPane()	Closes the pane. (Inherited from WindowPane)
IVsUIElementPane.CreateUIElementPane(Object)	Creates the pane. (Inherited from WindowPane)
IVsUIElementPane.GetDefaultUIElementSize(SIZE[])	When implemented in a derived class, gets the default size of the pane. (Inherited from WindowPane)
IVsUIElementPane.LoadUIElementState(IStream)	When implemented in a derived class, loads custom state storage. (Inherited from WindowPane)
IVsUIElementPane.SaveUIElementState(IStream)	Stores the state of the pane to the specified stream. (Inherited from WindowPane)
IVsUIElementPane.SetUIElementSite(IServiceProvider)	Sets the site for this window pane. (Inherited from WindowPane)
IVsUIElementPane.TranslateUIElementAccelerator(MSG[])	Handles keyboard accelerators before the shell processes the message. (Inherited from WindowPane)
IVsWindowPane.ClosePane()	Obsolete. Closes the window pane. Obsolete. (Inherited from WindowPane)
IVsWindowPane.CreatePaneWindow(IntPtr, Int32, Int32, Int32, Int32, IntPtr)	Obsolete. Creates a window pane. Obsolete. (Inherited from WindowPane)
IVsWindowPane.GetDefaultSize(SIZE[])	Obsolete. Gets the default size of the window pane. Obsolete. (Inherited from WindowPane)
IVsWindowPane.LoadViewState(IStream)	Obsolete. Loads the saved view state. Obsolete. (Inherited from WindowPane)
IVsWindowPane.SaveViewState(IStream)	Obsolete. Saves the loaded view state. Obsolete. (Inherited from WindowPane)
IVsWindowPane.SetSite(IServiceProvider)	Obsolete. Initializes this window pane with the specified service provider. Obsolete. (Inherited from WindowPane)
IVsWindowPane.TranslateAccelerator(MSG[])	Obsolete. Handles the translation of navigation keys. Obsolete (Inherited from WindowPane)