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)

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

NameDescription
System_CAPS_pubmethodCloseFrame(UInt32)

Closes a window.

System_CAPS_pubmethodGetFramePos(VSSETFRAMEPOS[], Guid, Int32, Int32, Int32, Int32)

Returns the position of the window.

System_CAPS_pubmethodGetGuidProperty(Int32, Guid)

Returns a window frame property based on a supplied GUID.

System_CAPS_pubmethodGetProperty(Int32, Object)

Returns a window property.

System_CAPS_pubmethodHide()

Hides a window.

System_CAPS_pubmethodIsOnScreen(Int32)

Returns true if the window frame is on the screen.

System_CAPS_pubmethodIsVisible()

Determines whether or not the window is visible.

System_CAPS_pubmethodQueryViewInterface(Guid, IntPtr)

Provides IVsWindowFrame with a view helper (VSFPROPID_ViewHelper) inserted into its list of event notifications.

System_CAPS_pubmethodSetFramePos(VSSETFRAMEPOS, Guid, Int32, Int32, Int32, Int32)

Sets the position of the window.

System_CAPS_pubmethodSetGuidProperty(Int32, Guid)

Sets a window frame property based on a supplied GUID.

System_CAPS_pubmethodSetProperty(Int32, Object)

Sets a window frame property.

System_CAPS_pubmethodShow()

Renders this window visible, brings the window to the top, and activates the window.

System_CAPS_pubmethodShowNoActivate()

Shows or makes a window visible and brings it to the top, but does not make it the active window.

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.

Return to top
Show: