LanguageService Class

Definition

public ref class LanguageService abstract : IDisposable, Microsoft::VisualStudio::OLE::Interop::IObjectWithSite, Microsoft::VisualStudio::OLE::Interop::IServiceProvider, Microsoft::VisualStudio::Shell::Interop::IVsDebuggerEvents, Microsoft::VisualStudio::TextManager::Interop::IVsAutoOutliningClient, Microsoft::VisualStudio::TextManager::Interop::IVsFormatFilterProvider, Microsoft::VisualStudio::TextManager::Interop::IVsLanguageContextProvider, Microsoft::VisualStudio::TextManager::Interop::IVsLanguageDebugInfo, Microsoft::VisualStudio::TextManager::Interop::IVsLanguageInfo, Microsoft::VisualStudio::TextManager::Interop::IVsProvideColorableItems, System::ComponentModel::ISynchronizeInvoke

[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class LanguageService : IDisposable, Microsoft.VisualStudio.OLE.Interop.IObjectWithSite, Microsoft.VisualStudio.OLE.Interop.IServiceProvider, Microsoft.VisualStudio.Shell.Interop.IVsDebuggerEvents, Microsoft.VisualStudio.TextManager.Interop.IVsAutoOutliningClient, Microsoft.VisualStudio.TextManager.Interop.IVsFormatFilterProvider, Microsoft.VisualStudio.TextManager.Interop.IVsLanguageContextProvider, Microsoft.VisualStudio.TextManager.Interop.IVsLanguageDebugInfo, Microsoft.VisualStudio.TextManager.Interop.IVsLanguageInfo, Microsoft.VisualStudio.TextManager.Interop.IVsProvideColorableItems, System.ComponentModel.ISynchronizeInvoke

[System.Runtime.InteropServices.ComVisible(true)]
public abstract class LanguageService : IDisposable, Microsoft.VisualStudio.OLE.Interop.IObjectWithSite, Microsoft.VisualStudio.OLE.Interop.IServiceProvider, Microsoft.VisualStudio.Shell.Interop.IVsDebuggerEvents, Microsoft.VisualStudio.TextManager.Interop.IVsAutoOutliningClient, Microsoft.VisualStudio.TextManager.Interop.IVsFormatFilterProvider, Microsoft.VisualStudio.TextManager.Interop.IVsLanguageContextProvider, Microsoft.VisualStudio.TextManager.Interop.IVsLanguageDebugInfo, Microsoft.VisualStudio.TextManager.Interop.IVsLanguageInfo, Microsoft.VisualStudio.TextManager.Interop.IVsProvideColorableItems, System.ComponentModel.ISynchronizeInvoke

[<System.CLSCompliant(false)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type LanguageService = class
    interface IDisposable
    interface IVsLanguageInfo
    interface IVsLanguageDebugInfo
    interface IVsProvideColorableItems
    interface IVsLanguageContextProvider
    interface IServiceProvider
    interface IObjectWithSite
    interface ISynchronizeInvoke
    interface IVsDebuggerEvents
    interface IVsFormatFilterProvider
    interface IVsAutoOutliningClient

[<System.Runtime.InteropServices.ComVisible(true)>]
type LanguageService = class
    interface IDisposable
    interface IVsLanguageInfo
    interface IVsLanguageDebugInfo
    interface IVsProvideColorableItems
    interface IVsLanguageContextProvider
    interface IServiceProvider
    interface IObjectWithSite
    interface ISynchronizeInvoke
    interface IVsDebuggerEvents
    interface IVsFormatFilterProvider
    interface IVsAutoOutliningClient

Public MustInherit Class LanguageService
Implements IDisposable, IObjectWithSite, IServiceProvider, ISynchronizeInvoke, IVsAutoOutliningClient, IVsDebuggerEvents, IVsFormatFilterProvider, IVsLanguageContextProvider, IVsLanguageDebugInfo, IVsLanguageInfo, IVsProvideColorableItems

Inheritance

Object

LanguageService

Attributes

CLSCompliantAttribute ComVisibleAttribute

Implements

IObjectWithSite IServiceProvider IVsDebuggerEvents IVsAutoOutliningClient IVsFormatFilterProvider IVsLanguageContextProvider IVsLanguageDebugInfo IVsLanguageInfo IVsProvideColorableItems ISynchronizeInvoke IDisposable

Examples

The following example shows how to register and initialize your language service for your package. Note: MyLanguageService is derived from the LanguageService class.

using System.ComponentModel.Design;  
using Microsoft.VisualStudio.Shell;  

namespace MyLanguagePackage  
{  
    /////////////////////////////////////////////  
    // Other package registration details go here  
    /////////////////////////////////////////////  

    // Offer a new language service  
    [ProvideServiceAttribute(typeof(MyLanguageService),  
                                       ServiceName = "My Language Service")]  

    // Register the language service with Visual Studio.  
    // "106" is the resource ID in the satellite DLL to the localized language name.  
    [ProvideLanguageServiceAttribute(typeof(MyLanguageService),"My Language",106)]  

    // Associate a file extension with our language service.  
    [ProvideLanguageExtensionAttribute(typeof(MyLanguageService), ".myext")]  

    class MyLanguagePackage : Package  
    {  
        protected override void Initialize()  
        {  
            base.Initialize();  

            IServiceContainer serviceContainer = this as IServiceContainer;  
            MyLanguageService languageService = new MyLanguageService();  
            languageService.SetSite(this);  
            serviceContainer.AddService(typeof(MyLanguageService),  
                                        languageService,  
                                        true);  
        }  
    }  
}  

Remarks

Visual Studio uses language services to provide support for code languages. A language service is registered with Visual Studio when the language service package is installed. Part of this registration process associates a file extension with a language service so any time a file with that extension is loaded, the language service is also loaded.

The LanguageService class is the base class for your language service. Visual Studio instantiates the VSPackage implementing your language service and calls the SetSite method on the VSPackage. In the implementation of this method, the Initialize method on the Package base class is called. Override the Initialize method to instantiate your language service. Remember to call the SetSite method on your language service after instantiation.

Notes to Implementers

Derive a class from this class to create your own language service. You must also, at the very least, implement a parser that implements the IScanner interface. All features of a language service are based on this parser.

The following methods and property are marked as abstract and must be implemented in a class derived tom the LanguageService class:

If you do not intend to support the ValidateBreakpointLocation(IVsTextBuffer, Int32, Int32, TextSpan[]) but your language does support breakpoints, you must override the ValidateBreakpointLocation(IVsTextBuffer, Int32, Int32, TextSpan[]) method and return a span that contains the specified line and column; otherwise, breakpoints cannot be set anywhere except line 1. You can return E_NOTIMPL to indicate that you do not otherwise support this method but the span must always be set. The example in the ValidateBreakpointLocation(IVsTextBuffer, Int32, Int32, TextSpan[]) method shows how this can be done.

Notes to Callers

Register your language service when installing your VSPackage (this could be a package dedicated to your language service or it could be a project package that also supplies a language service). You instantiate your own language service during your package initialization. Visual Studio interacts with your language service to display code written in the language supported by your language service. See the example below for how this language registration can be done.

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to