This documentation is archived and is not being maintained.

IVsWindowFrame Interface

Provides access to behaviors and properties of environment window frames, for both tool and document windows.

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

[InterfaceTypeAttribute()]
[GuidAttribute("11138F8A-38C0-4436-B5A6-2F5EF2C3E242")]
public interface IVsWindowFrame

The IVsWindowFrame type exposes the following members.

  NameDescription
Public methodCloseFrameCloses a window.
Public methodGetFramePosReturns the position of the window.
Public methodGetGuidPropertyReturns a window frame property based on a supplied GUID.
Public methodGetPropertyReturns a window property.
Public methodHideHides a window.
Public methodIsOnScreenReturns true if the window frame is on the screen.
Public methodIsVisibleDetermines whether or not the window is visible.
Public methodQueryViewInterfaceProvides IVsWindowFrame with a view helper (VSFPROPID_ViewHelper) inserted into its list of event notifications.
Public methodSetFramePosSets the position of the window.
Public methodSetGuidPropertySets a window frame property based on a supplied GUID.
Public methodSetPropertySets a window frame property.
Public methodShowRenders this window visible, brings the window to the top, and activates the window.
Public methodShowNoActivateShows or makes a window visible and brings it to the top, but does not make it the active window.
Top

The environment does not provide two modes for controls hosted in an IVsWindowFrame object. A check for ambient properties returns null indicating that ambient properties are not supported.

A VSPackage that implements IOleObject, such as an editor that uses a document window, might call the GetAmbientUserMode method to check for design mode or run mode. While the guidelines for ActiveX control containers state that the containers (or sites) should support ambient properties, this doesn't work in Visual Studio because the site created for the VSPackage does not support ambient properties.

UserMode normally indicates the mode in which the control should be run:

Run Mode

UserMode == false

or

DesignMode

UserMode == true

Notes to Callers

Call IVsWindowFrame to obtain an IVsWindowFrame pointer to call methods on a document or tool window. IVsWindowFrame is implemented by the environment through the SVsWindowFrame service.

Show: