This topic has not yet been rated - Rate this topic

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(1)] 
[GuidAttribute("11138F8A-38C0-4436-B5A6-2F5EF2C3E242")] 
public interface IVsWindowFrame
/** @attribute InterfaceTypeAttribute(1) */ 
/** @attribute GuidAttribute("11138F8A-38C0-4436-B5A6-2F5EF2C3E242") */ 
public interface IVsWindowFrame
InterfaceTypeAttribute(1) 
GuidAttribute("11138F8A-38C0-4436-B5A6-2F5EF2C3E242") 
public interface IVsWindowFrame

See illustrations of the implementation and/or calling of this interface in the samples Basic Edit Overview, Basic Project Sample, Figures Project Sample, Figures Edit Sample, and Solution Extender Sample.

The environment does not provide two modes for controls hosted in an IVsWindowFrame object. A check for ambient properties returns a 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.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ