Overview of the Programming Model of SharePoint Tools Extensions
When you create an extension for the SharePoint tools in Visual Studio, you begin by implementing one or more extensibility interfaces that are exposed by the SharePoint tools. In most cases, you will also use other types provided by the SharePoint tools to implement features in your extension. In some scenarios you might also use types in other object models provided by Visual Studio and SharePoint. You must understand the purpose of each of these object models and know how to use them with each other to create extensions for the SharePoint tools.
Extending the SharePoint Tools by Implementing Extensibility Interfaces
Visual Studio uses the Managed Extensibility Framework (MEF) in the .NET Framework 4 to provide the extensibility model for the SharePoint tools. MEF is an API (implemented in the System.ComponentModel.Composition assembly) that enables applications to expose extensibility points and to discover and load extensions at run time. For more information about MEF, see Managed Extensibility Framework (MEF).
To extend the SharePoint tools, implement one or more extensibility interfaces that are exposed by Visual Studio. You must also apply the System.ComponentModel.Composition.ExportAttribute, and additional SharePoint tools-specific attributes as necessary, to your interface implementation. The following table lists the interfaces you can implement to extend the SharePoint tools.
Interface |
Description |
|---|---|
Implement this interface to define a new type of SharePoint project item. For an example, see How to: Define a SharePoint Project Item Type. |
|
Implement this interface to extend a type of SharePoint project item that is already installed in Visual Studio. For an example, see How to: Create a SharePoint Project Item Extension. |
|
Implement this interface to extend SharePoint projects. For an example, see How to: Create a SharePoint Project Extension. |
|
Implement this interface to define a new deployment step that can be executed when a SharePoint project item is deployed or retracted. For an example, see Walkthrough: Creating a Custom Deployment Step for SharePoint Projects. |
|
Implement this interface to extend an existing node under the SharePoint Connections node in the Server Explorer window. For an example, see How to: Extend a SharePoint Node in Server Explorer. |
|
Implement this interface to define a new type of node under the SharePoint Connections node in the Server Explorer window. For an example, see How to: Extend a SharePoint Node in Server Explorer. |
|
Implement this interface to define a custom feature validation rule. For an example, see How to: Create Custom Feature and Package Validation Rules for SharePoint Solutions. |
|
Implement this interface to define a custom package validation rule. For an example, see How to: Create Custom Feature and Package Validation Rules for SharePoint Solutions. |
After you implement an extension of the SharePoint tools, you must deploy the extension assembly in a Visual Studio extension (VSIX) package to enable Visual Studio to discover and load the extension. For more information, see Deploying Extensions for the SharePoint Tools in Visual Studio.
Understanding the Object Models That You Use in SharePoint Tools Extensions
There are several object models you can use when you create extensions for the SharePoint tools:
SharePoint tools object model. This object model provides the extensibility interfaces that you implement to create SharePoint tools extensions, and other related types.
Visual Studio automation and integration object models. Use these object models to access Visual Studio features that are beyond the scope of the SharePoint tools object model.
Note
You can convert some objects in the SharePoint tools object model to objects in the Visual Studio automation and integration object models, and vice versa, by using the SharePoint project service. For more information, see Converting Between SharePoint Project System Types and Other Visual Studio Project Types.
SharePoint server and client object models. Use these object models to modify a SharePoint site or to retrieve data from a SharePoint site from the context of a SharePoint tools extension.
SharePoint Tools Object Model
Each SharePoint tools extension uses types in the SharePoint tools object model to define the core behavior and functionality of the extension. The following table describes the namespaces that are included in this object model.
Assembly |
Namespace |
Description |
|---|---|---|
Microsoft.VisualStudio.SharePoint.dll |
Contains types that you use to extend and automate the SharePoint project system. For example, you can extend the built-in SharePoint projects and project items, or you can create your own project items. For more information, see Extending the SharePoint Project System. |
|
Contains types that you use to extend the deployment process for SharePoint projects, such as creating your own deployment steps and deployment configurations. For more information, see Extending SharePoint Packaging and Deployment. |
||
Contains types that you use to extend nodes under the SharePoint Connections node in the Server Explorer window, or to define new types of nodes. For more information, see Extending the SharePoint Connections Node in Server Explorer. |
||
Contains types that you use to access the Feature definitions in a SharePoint project. |
||
Contains types that you use to access the package definition in a SharePoint solution. |
||
Contains types that you use to customize the Feature and package validation behavior for SharePoint projects. For more information, see How to: Create Custom Feature and Package Validation Rules for SharePoint Solutions. |
||
Microsoft.VisualStudio.SharePoint.Commands.dll |
Contains types that you can use to create custom SharePoint commands. A SharePoint command is a method that calls into the SharePoint server object model from a SharePoint tools extension. For more information, see Calling into the SharePoint Object Models. |
|
Microsoft.VisualStudio.SharePoint.Explorer.Extensions.dll |
Contains types that you can use to get information about built-in Server Explorer nodes that represent individual components on a SharePoint site, such as a node that represents a list, field, or content type. For more information, see Extending the SharePoint Connections Node in Server Explorer. |
Visual Studio Automation Object Model
The Visual Studio automation object model provides APIs that you can use to automate Visual Studio projects and the IDE. Use the Visual Studio object model to perform project-related tasks that are not specific to SharePoint projects, or to perform other general automation tasks in Visual Studio. Traditionally, this object model is often used in Visual Studio add-ins and macros, but you can also use it in SharePoint tools extensions.
The main part of the Visual Studio automation object model is defined in the EnvDTE.dll assembly. The EnvDTE80.dll, EnvDTE90.dll, EnvDTE100.dll, and EnvDTE110.dll assemblies provide additional functionality that was introduced in Visual Studio 2005, Visual Studio 2008, Visual Studio 2010, and Visual Studio 2012, respectively. These assemblies are included with Visual Studio.
For more information about the automation object model, see Extending the Visual Studio Environment and Automation and Extensibility Reference.
Visual Studio Integration Object Model
The integration object model provides APIs that you can use to add features to Visual Studio by creating a VSPackage. A VSPackage is a module that extends the Visual Studio IDE by providing custom features such as tool windows, editors, designers, services, and projects.
You can use the integration object model if you want to add a new Visual Studio feature that will be used with the built-in SharePoint tools. For example, if you create a custom SharePoint project item that represents a custom action for a SharePoint site, you can also create a VSPackage that implements a designer for the custom action. You can associate the designer with the custom action by adding a shortcut menu item to the project item that represents the custom action in Solution Explorer. You can open your designer by opening its shortcut menu (either by right-clicking the custom action project item or by choosing it and then choosing the Shift + F10 keys) and then choosing Open.
This object model is defined in a set of assemblies that are included with the Visual Studio SDK. Some of the main assemblies in this object model include Microsoft.VisualStudio.Shell.11.0.dll, Microsoft.VisualStudio.Shell.Interop.dll, and Microsoft.VisualStudio.OLE.Interop.dll.
For more information about the integration object model, see Visual Studio Development Environment Model and Visual Studio SDK Reference.
SharePoint Object Models
SharePoint tools extensions can use SharePoint APIs to modify a SharePoint site or to retrieve data from a SharePoint site. Microsoft SharePoint Foundation 2010 and Microsoft SharePoint Server 2010 provide two different object models: a server object model and a client object model.
You can use APIs in either object model in a SharePoint tools extension, but each object model has some benefits and drawbacks in the context of SharePoint tools extensions. For more information, see Calling into the SharePoint Object Models.
Object model |
Description |
|---|---|
Server object model |
The server object model provides access to all of the features that Microsoft SharePoint Foundation 2010 and Microsoft SharePoint Server 2010 expose programmatically. This object model is designed to be used by SharePoint solutions that run on the SharePoint server. The majority of this object model is defined in the Microsoft.SharePoint.dll assembly. For more information about the server object model, see Using the SharePoint Foundation Server-Side Object Model. |
Client object model |
The client object model is a subset of the server object model that can be used to interoperate with SharePoint data from a remote client or server. It is designed to minimize the number of round trips that must be executed to perform common tasks. The majority of the client object model is defined in the Microsoft.SharePoint.Client.dll and Microsoft.SharePoint.Client.Runtime.dll assemblies. For more information about the client object model, see Managed Client Object Model. |
See Also
Concepts
Calling into the SharePoint Object Models
Visual Studio Development Environment Model
Using the SharePoint Project Service