Share via


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)

Syntax

'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("11138F8A-38C0-4436-B5A6-2F5EF2C3E242")> _
Public Interface IVsWindowFrame
[InterfaceTypeAttribute()]
[GuidAttribute("11138F8A-38C0-4436-B5A6-2F5EF2C3E242")]
public interface IVsWindowFrame
[InterfaceTypeAttribute()]
[GuidAttribute(L"11138F8A-38C0-4436-B5A6-2F5EF2C3E242")]
public interface class IVsWindowFrame
[<InterfaceTypeAttribute()>]
[<GuidAttribute("11138F8A-38C0-4436-B5A6-2F5EF2C3E242")>]
type IVsWindowFrame =  interface end
public interface IVsWindowFrame

The IVsWindowFrame type exposes the following members.

Methods

  Name Description
Public method CloseFrame Closes a window.
Public method GetFramePos Returns the position of the window.
Public method GetGuidProperty Returns a window frame property based on a supplied GUID.
Public method GetProperty Returns a window property.
Public method Hide Hides a window.
Public method IsOnScreen Returns true if the window frame is on the screen.
Public method IsVisible Determines whether or not the window is visible.
Public method QueryViewInterface Provides IVsWindowFrame with a view helper (VSFPROPID_ViewHelper) inserted into its list of event notifications.
Public method SetFramePos Sets the position of the window.
Public method SetGuidProperty Sets a window frame property based on a supplied GUID.
Public method SetProperty Sets a window frame property.
Public method Show Renders this window visible, brings the window to the top, and activates the window.
Public method ShowNoActivate Shows or makes a window visible and brings it to the top, but does not make it the active window.

Top

Remarks

The environment does not provide two modes for controls hosted in an IVsWindowFrame object. A check for ambient properties returns nulla null reference (Nothing in Visual Basic) 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.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace