IVsCodeWindow Interface

Represents a multiple-document interface (MDI) child that contains one or more code views.

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

[InterfaceTypeAttribute()]
[GuidAttribute("8560CECD-DFAC-4F7B-9D2A-E6D9810F3443")]
public interface IVsCodeWindow

The IVsCodeWindow type exposes the following members.

  NameDescription
Public methodCloseCloses the code window.
Public methodGetBufferReturns the buffer used by all views in the code window.
Public methodGetEditorCaptionReturns the editor caption to which editors can append custom text.
Public methodGetLastActiveViewReturns the last active view of the code window.
Public methodGetPrimaryViewReturns the top (or primary) view of a split code window.
Public methodGetSecondaryViewReturns the bottom (or secondary) view of a split code window.
Public methodGetViewClassIDReturns the text view class to change or query.
Public methodSetBaseEditorCaptionAppends custom text to the editor caption
Public methodSetBufferSets the text buffer for all views in the code window.
Public methodSetViewClassIDSets the text view class to change or query.
Top

The code window hosts the views for a text buffer and provides the ability to split views. A code window is a frame window that can enclose one or more views. In MDI mode, the code window is the MDI child frame. Each language service can provide its own code window manager, which allows it to add special adornments, such as a drop-down bar, to the code window.

Notes to Implementers

The environment implements a default configuration of this interface. This implementation is typically used to support an editor, such as the core editor, by using IVsTextView to display source.

Any non-core editors or designers that support a LOGVIEWID_TextView logical view must implement IVsCodeWindow on their document view to support IDE Find and Navigate operations.

Notes to Callers

Call IVsCodeWindow to access the views associated with the code window.

An interface to the default code window implementation can be obtained by calling CreateInstance, with a class ID of CLSID_VsCodeWindow and an interface ID of IID_IVsCodeWindow. The interface is typically exposed through an instance of the core editor.

Applications that do not use the core editor, but need a code window must implement it on a document view object.

Support of IDE find operations requires full implementation of GetLastActiveView,GetPrimaryView, and GetBuffer.

An example of how to apply an IVsCodeWindow interface to either a default or to a non-standard implementation of a code window can be found in the discussion Single and Multi-tab Views.

A given code window is always owned by one language service. When the code window is created, the language service is allowed to attach an IVsCodeWindowManager instance to the code window. At the appropriate time during initialization, the code window calls AddAdornments, at which time the language service can add a drop-down bar or other widgets.

Only one text buffer can exist per code window.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft