Skip to content

Latest commit

 

History

History
 
 

Reference_Services

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
C#
C#
 
 
Readme.md
Readme.md
 
 

Readme.md

Reference Services Sample

Demonstrates how to be a Visual Studio service provider and consume Visual Studio services.

  • Technologies: Visual Studio 2015 SDK
  • Topics: Visual Studio Shell, VSX

Description

This sample shows how to create and expose services inside Visual Studio. It creates two services with two different levels of visibility. The service with global visibility is available for any of Visual Studio's other components. The service with local visibility is available only from within the package itself or when the IServiceProvider interface implemented by the package is inside the chain of active providers.

The sample creates two assemblies, one with the definition of the interfaces used and one with the actual implementation of the packages and services. The assembly with the implementation, created by the Reference.Services project, defines two packages. One package exposes the services and a second package uses them. The services are implemented with two helper classes.

The ServicesPackage class demonstrates how to proffer services. Specifically:

  1. In the class declaration we use the ProvideServiceAttribute registration attribute defined in the Managed Package Framework to add information about the global service to the registry.
  2. The constructor adds the proffered service types to the services list provided by the package. At this point we don’t create any instance of the service, we provide a callback function to call the first time a client queries for a specific service. This optimizes performance, we don’t want to construct something that might never be used.
  3. The callback function used to create a new instance of the services.

image

Requirements

Visual Studio 2015

Get all samples

Clone the repo (How to):

git clone https://github.com/Microsoft/VSSDK-Extensibility-Samples.git

Run the sample

  1. To run the sample, hit F5 or choose the Debug > Start Debugging menu command. A new instance of Visual Studio will launch under the experimental hive.
  2. Once loaded, open the Tools drop menu.
  3. Three new buttons are displayed at the top of the Tools menu: Get C# Global Service, Get C# Local Service, and Get C# Local using Global Service

Related topics