Extend the SharePoint connections node in Server Explorer

Applies to: Visual Studio Visual Studio for Mac

In Visual Studio, you can connect to local SharePoint sites on the development computer by using the SharePoint Connections node in the Server Explorer window. This node displays many of the components of local SharePoint sites in a hierarchical tree view. For example, you can view the lists, document libraries, and content types on local sites. For more information about using Server Explorer to connect to local SharePoint sites, see Browse SharePoint connections using Server Explorer.

You can extend the SharePoint Connections node by creating extensions for existing nodes, or by creating a custom node type and adding it to the hierarchy of nodes.

Tasks for extending the SharePoint connections node

To extend an existing node, create a Visual Studio extension that implements the IExplorerNodeTypeExtension interface. When you extend a node, you can add functionality to the node such as your own shortcut menu items or custom properties. For more information, see How to: Extend a SharePoint node in Server Explorer.

To create a custom node type, create a Visual Studio extension that implements the IExplorerNodeTypeProvider interface. Create a custom node if you want to display components of SharePoint sites that are not displayed in Server Explorer by default. For example, Server Explorer does not display the Web Part gallery of a SharePoint site by default, but you can add a custom node that does this. For more information, see How to: Add a custom SharePoint node to Server Explorer and Walkthrough: Extend Server Explorer to Display Web Parts.

Add custom properties to nodes

When you extend a node or create a custom node type, you can add custom properties to the node. The properties appear in the Properties window when the node is selected.

There are two types of custom properties you can add to a node:

• Properties that display a set of read-only data from the SharePoint site. The data describes the SharePoint component that the node represents. For a walkthrough that demonstrates how to do this, see Walkthrough: Extend Server Explorer to display web parts.

• Properties that display custom read/write data. For a code example that demonstrates how to do this, see How to: Extend a SharePoint node in Server Explorer.

Get data for built-in nodes

All of the built-in nodes provided by Visual Studio include some data about the SharePoint component that they represent. For example, a node that represents a list on the SharePoint site provides some data about the list, such as the title and the URL of the default view for the list.

To access this data, retrieve a data object from the Annotations property of the IExplorerNode object that represents the node you are interested in. The type of the data object depends on the type of the node.

The following code example demonstrates how to get the data object for a list node. To see this example in the context of a larger example, see How to: Get data for a built-in SharePoint node in Server Explorer.

Dim nodeInfo As IListNodeInfo = node.Annotations.GetValue(Of IListNodeInfo)()

IListNodeInfo nodeInfo = node.Annotations.GetValue<IListNodeInfo>();

The following table lists the data object types for each built-in node type.

For more information about using the Annotations property, see Associate custom data with SharePoint tools extensions.

See also

• Walkthrough: Extend Server Explorer to display web parts
• How to: Extend a SharePoint node in Server Explorer
• How to: Add a custom SharePoint node to Server Explorer
• How to: Get data for a built-in SharePoint node in Server Explorer
• Associate custom data with SharePoint tools extensions
• Browse SharePoint connections using Server Explorer
• Extend the SharePoint tools in Visual Studio