WindowPane Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a Visual Studio window pane.

public ref class WindowPane abstract : IDisposable, IServiceProvider, Microsoft::VisualStudio::OLE::Interop::IOleCommandTarget, Microsoft::VisualStudio::Shell::Interop::IVsUIElementPane, Microsoft::VisualStudio::Shell::Interop::IVsWindowPane

[System.Runtime.InteropServices.ComVisible(true)]
[System.Windows.Markup.ContentProperty("Content")]
public abstract class WindowPane : IDisposable, IServiceProvider, Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget, Microsoft.VisualStudio.Shell.Interop.IVsUIElementPane, Microsoft.VisualStudio.Shell.Interop.IVsWindowPane

[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Windows.Markup.ContentProperty("Content")>]
type WindowPane = class
    interface IOleCommandTarget
    interface IServiceProvider
    interface IVsWindowPane
    interface IVsUIElementPane
    interface IDisposable

Public MustInherit Class WindowPane
Implements IDisposable, IOleCommandTarget, IServiceProvider, IVsUIElementPane, IVsWindowPane

Inheritance: Object
WindowPane

Derived: Microsoft.VisualStudio.Modeling.Shell.ModelingWindowPane

Microsoft.VisualStudio.Shell.Design.DesignerWindowPane

Microsoft.VisualStudio.Shell.ToolWindowPane

Attributes: ComVisibleAttribute ContentPropertyAttribute

Implements: IOleCommandTarget IVsUIElementPane IVsWindowPane IDisposable IServiceProvider

Remarks

This class implements IVsUIElementPane, which allows you use WPF elements as windows. This class also implements IOleCommandTarget, maps it to IMenuCommandService and IObjectWithSite, and maps the site to services that can be queried through its protected GetService method.

This class also implements IVsWindowPane, but the methods are now obsolete.

Constructors

WindowPane()	Creates a new window pane with a null parent service provider
WindowPane(IServiceProvider)	Initializes a new instance of WindowPane with the specified service provider.

Properties

Content	Gets or sets the content of this tool window.
InitializationMode	Gets the initialization mode that is associated with this window pane.
ParentHandle
Window	Gets the window associated with this window pane.

Methods

Dispose()	Disposes the window pane and its resources.
Dispose(Boolean)	Disposes the resources of the window pane.
GetService(Type)	Gets the service of the specified type.
Initialize()	Initializes services after the window pane has been sited.
LoadUIState(Stream)	Override to load previously saved state of the pane
OnClose()	Raised when the window is closed.
OnCreate()	Raised when the window pane is created.
PreProcessMessage(Message)	Preprocesses the messages from navigation keys.
SaveUIState(Stream)	Override to save custom state information to be used later when the pane is reconstructed.

Explicit Interface Implementations

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

Applies to

Share via