Creating a Basic SharePoint Foundation Client Application

Article
10/20/2016

Applies to: SharePoint Foundation 2010

To create a .NET managed client application that uses the client object model, you must set references to two client library DLLs-- Microsoft.SharePoint.Client.dll and Microsoft.SharePoint.Client.Runtime.dll. You can copy these DLLs from the %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\ISAPI folder of the server that runs Microsoft SharePoint Foundation 2010 to the remote computer on which you create the application.

Creating a basic console application

The following programming task steps through the procedure of creating a basic console application in Microsoft Visual Studio that uses objects in the Microsoft.SharePoint.Client namespace to return Web site properties.

On the File menu, point to New and click Project.
In the New Project dialog box, select Visual Basic or Visual C# in the Installed Templates panel. Select Windows and then Console Application. Choose .NET Framework 3.5 from the drop-down at the top of the center panel. Type a name and location for the project in the Name and Location boxes. Then click OK.
In Windows Explorer, copy the two DLLs from the server's %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\ISAPI folder into the top-level folder of your console application.
Right-click the project in Solution Explorer, click Add Reference, and in the Add Reference dialog box, click the Browse tab and navigate to the folder where you copied Microsoft.SharePoint.Client.dll and Microsoft.SharePoint.Client.Runtime.dll. Select the two DLLs, and click OK.

The following example returns and displays the title of the Web site at the URL that is specified in the ClientContext() constructor. The Load<T>(T, []) method specifies which object to retrieve from the server, which in this case is the Web site, and ExecuteQuery() performs the query. Because the Web site object is loaded, all its default properties become available for display at the console. For information about properties that are not available by default when you load and object or collection, see Data Retrieval Overview.

using System;
using Microsoft.SharePoint.Client;
namespace Microsoft.SDK.SharePointServices.Samples
{
    class DisplayWebTitle
    {
        static void Main()
        {
            ClientContext clientContext = new ClientContext("http://MyServer/sites/MySiteCollection/MyWebSite");
            Web oWebsite = clientContext.Web;  
            clientContext.Load(oWebsite);
            clientContext.ExecuteQuery();

            Console.WriteLine("Title: {0} Created: {1}", oWebsite.Title, oWebsite.Created);
        }
    }
}

Imports System
Imports Microsoft.SharePoint.Client

Namespace Microsoft.SDK.SharePointServices.Samples

    Class DisplayWebTitle

        Public Overloads Shared Sub Main()

            Dim clientContext As New ClientContext("http://MyServer/sites/MySiteCollection/MyWebSite")
            Dim oWebsite As Web = clientContext.Web
            clientContext.Load(oWebsite)
            clientContext.ExecuteQuery()

            Console.WriteLine("Title: {0} Created: {1}", oWebsite.Title, oWebsite.Created)

        End Sub
    End Class
End Namespace

Press F5 to run the application and display the title and created date of the Web site at the console.

Share via

Creating a Basic SharePoint Foundation Client Application

Creating a basic console application

See Also

Concepts

Other Resources

Additional resources