ISharePointConnection Interface

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Provides methods you can use to execute SharePoint commands that call into the SharePoint server object model from an extension of the SharePoint tools in Visual Studio.

Namespace: Microsoft.VisualStudio.SharePoint
Assembly: Microsoft.VisualStudio.SharePoint (in Microsoft.VisualStudio.SharePoint.dll)

Syntax

'Declaration
Public Interface ISharePointConnection _
    Inherits IDisposable
public interface ISharePointConnection : IDisposable

The ISharePointConnection type exposes the following members.

Properties

Name Description
Public property AuthenticationMode
Public property IsEnabled Gets or sets the flag indicating if the connection is enabled.
Public property SiteUrl Gets the url to the SharePoint site that is connected to.

Top

Methods

Name Description
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method ExecuteCommand(String) Executes the SharePoint command with the specified identifier.
Public method ExecuteCommand<TResult>(String) Executes the SharePoint command with the specified identifier and return value type.
Public method ExecuteCommand<T>(String, T) Executes the SharePoint command with the specified identifier and parameter type.
Public method ExecuteCommand<T, TResult>(String, T) Executes the SharePoint command with the specified identifier, parameter type, and return value type.

Top

Remarks

SharePoint commands are methods that can be used in a SharePoint tools extension to call into the SharePoint server object model. After you define a SharePoint command, you can execute it by obtaining an ISharePointConnection object and then calling one of the ExecuteCommand methods. For more information, see How to: Execute a SharePoint Command.

See Also

Reference

Microsoft.VisualStudio.SharePoint Namespace

Other Resources

Calling into the SharePoint Object Models

How to: Create a SharePoint Command

How to: Execute a SharePoint Command