Share via


WindowPane Class

Represents a Visual Studio window pane.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Shell.WindowPane
    Microsoft.VisualStudio.Shell.Design.DesignerWindowPane
    Microsoft.VisualStudio.Shell.ToolWindowPane

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)

Syntax

'Declaration
<ContentPropertyAttribute("Content")> _
<ComVisibleAttribute(True)> _
Public MustInherit Class WindowPane _
    Implements IOleCommandTarget, IServiceProvider, IVsWindowPane, IVsUIElementPane,  _
    IDisposable
[ContentPropertyAttribute("Content")]
[ComVisibleAttribute(true)]
public abstract class WindowPane : IOleCommandTarget, 
    IServiceProvider, IVsWindowPane, IVsUIElementPane, IDisposable
[ContentPropertyAttribute(L"Content")]
[ComVisibleAttribute(true)]
public ref class WindowPane abstract : IOleCommandTarget, 
    IServiceProvider, IVsWindowPane, IVsUIElementPane, IDisposable
[<AbstractClass>]
[<ContentPropertyAttribute("Content")>]
[<ComVisibleAttribute(true)>]
type WindowPane =  
    class
        interface IOleCommandTarget
        interface IServiceProvider
        interface IVsWindowPane
        interface IVsUIElementPane
        interface IDisposable
    end
public abstract class WindowPane implements IOleCommandTarget, IServiceProvider, IVsWindowPane, IVsUIElementPane, IDisposable

The WindowPane type exposes the following members.

Constructors

  Name Description
Protected method WindowPane() Initializes a new instance of WindowPane with a nulla null reference (Nothing in Visual Basic) parent service provider
Protected method WindowPane(IServiceProvider) Initializes a new instance of WindowPane with the specified service provider.

Top

Properties

  Name Description
Public property Content Gets or sets the content of this tool window.
Protected property InitializationMode Gets the initialization mode that is associated with this window pane.
Public property Window Gets the window associated with this window pane.

Top

Methods

  Name Description
Public method Dispose() Disposes the window pane and its resources.
Protected method Dispose(Boolean) Disposes the resources of 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.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetService Gets the service of the specified type.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Initialize Initializes services after the window pane has been sited.
Public method LoadUIState Override to load the previously saved state of the pane.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnClose Raised when the window is closed.
Protected method OnCreate Raised when the window pane is created.
Protected method PreProcessMessage Preprocesses the messages from navigation keys.
Public method SaveUIState Override to save custom state information to be used later when the pane is reconstructed.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IServiceProvider.GetService Gets the service of the specified type.
Explicit interface implemetationPrivate method IOleCommandTarget.Exec Executes the specified command.
Explicit interface implemetationPrivate method IOleCommandTarget.QueryStatus Gets the status of the commands.
Explicit interface implemetationPrivate method IVsUIElementPane.CloseUIElementPane Closes the pane.
Explicit interface implemetationPrivate method IVsUIElementPane.CreateUIElementPane Creates the pane.
Explicit interface implemetationPrivate method IVsUIElementPane.GetDefaultUIElementSize When implemented in a derived class, gets the default size of the pane.
Explicit interface implemetationPrivate method IVsUIElementPane.LoadUIElementState When implemented in a derived class, loads custom state storage.
Explicit interface implemetationPrivate method IVsUIElementPane.SaveUIElementState Stores the state of the pane to the specified stream.
Explicit interface implemetationPrivate method IVsUIElementPane.SetUIElementSite Sets the site for this window pane.
Explicit interface implemetationPrivate method IVsUIElementPane.TranslateUIElementAccelerator Handles keyboard accelerators before the shell processes the message.
Explicit interface implemetationPrivate method IVsWindowPane.ClosePane Obsolete. Closes the window pane. Obsolete.
Explicit interface implemetationPrivate method IVsWindowPane.CreatePaneWindow Obsolete. Creates a window pane. Obsolete.
Explicit interface implemetationPrivate method IVsWindowPane.GetDefaultSize Obsolete. Gets the default size of the window pane. Obsolete.
Explicit interface implemetationPrivate method IVsWindowPane.LoadViewState Obsolete. Loads the saved view state. Obsolete.
Explicit interface implemetationPrivate method IVsWindowPane.SaveViewState Obsolete. Saves the loaded view state. Obsolete.
Explicit interface implemetationPrivate method IVsWindowPane.SetSite Obsolete. Initializes this window pane with the specified service provider. Obsolete.
Explicit interface implemetationPrivate method IVsWindowPane.TranslateAccelerator Obsolete. Handles the translation of navigation keys. Obsolete

Top

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.

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.Shell Namespace