CodeWindowManager Class

 

Wraps an IVsCodeWindow object for use in a language service.

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

System.Object
  Microsoft.VisualStudio.Package.CodeWindowManager

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public class CodeWindowManager : IVsCodeWindowManager

NameDescription
System_CAPS_pubmethodCodeWindowManager(LanguageService, IVsCodeWindow, Source)

Initializes the CodeWindowManager class.

NameDescription
System_CAPS_pubpropertyCodeWindow

Returns the IVsCodeWindow this CodeWindowManager is managing.

System_CAPS_pubpropertyDropDownHelper

Returns the drop-down helper class.

System_CAPS_pubpropertyLanguageService

Returns the language service that owns this code window manager.

System_CAPS_pubpropertyProperties

Allows retrieving and updating the document properties.

System_CAPS_pubpropertySource

Returns the Source object associated with the view managed by this code window manager class.

NameDescription
System_CAPS_pubmethodAddAdornments()

Called to add adornments or additional user interface (UI) elements to the text view.

System_CAPS_pubmethodClose()

Close down the CodeWindowManager object.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

The destructor for the CodeWindowManager class.(Overrides Object.Finalize().)

System_CAPS_pubmethodGetFilter(IVsTextView)

Returns the ViewFilter object associated with the specified text view.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodOnKillFocus(IVsTextView)

Called when the specified text view loses focus.

System_CAPS_pubmethodOnNewView(IVsTextView)

Called when a new text view is created.

System_CAPS_pubmethodOnSetFocus(IVsTextView)

Called when the specified text view receives the focus.

System_CAPS_pubmethodRemoveAdornments()

Called to remove any adornments on a text view that is being closed.

System_CAPS_pubmethodToString()

(Inherited from Object.)

This class provides a default implementation of the VSIP interface, IVsCodeWindowManager and manages the LanguageService, Source, ViewFilter, and DocumentProperties objects associated with the given IVsCodeWindow.

This class calls CreateViewFilter on your LanguageService for each new IVsTextView created by Visual Studio and installs the resulting filter into the command chain. You do not have to override CreateViewFilter, since a default view filter will be created.

If your LanguageService returns an object from CreateDocumentProperties then you will have properties in the Properties window associated with your source files.

This class also provides support for optional drop-down combo boxes (also known as drop-down bars), as represented by the IVsDropdownBar interface, for listing types and members by installing the TypeAndMemberDropdownBars object returned from your CreateDropDownHelper method. If you do not implement CreateDropDownHelper, no drop down-bars are established.

Notes to Implementers:

If you need to add any user interface (UI) features to the view window, you can derive a class from the CodeWindowManager class and override the methods AddAdornments and RemoveAdornments; just be sure to call the base class versions of those methods in your implementations. Otherwise, the base class handles all normal chores associated with a language service.

Notes to Callers:

The LanguageService class maintains a list of CodeWindowManagers, one instance for each text view or open source file. The only methods called by Visual Studio are AddAdornments and RemoveAdornments (these are called directly) and CodeWindowManager.OnSetFocus and CodeWindowManager.OnKillFocus (these are called indirectly through the ViewFilter class in its implementation of the IVsTextViewEvents interface).

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: