Overview of the SharePoint Workspace SDK

In this article
Sample Programs
Visual Studio Project
Documentation

The SDK consists of the following:

  • Sample Programs

  • Visual Studio Project

  • Documentation

These files are provided in a self-extracting executable.

The .dlls libraries that provide the API are not part of the SDK. These libraries are part of the SharePoint Workspace 2010 SP1 release.

Sample Programs

There are three sample C# projects provided in the SDK:

  • QuerySample—shows how to access data including queries.

  • PhotosWPF—shows how to use attachments, events, and dynamic controls on the Ribbon.

  • AttachmentsAndConflicts—shows how to use attachments, resolve conflicts and use dynamic controls on the Ribbon.

These samples are provided as Visual Studio projects. To run the samples, you must do the following:

  1. Build the solution.

  2. Copy the built .dll libraries and manifest to the installation folder, which is specified in the registry file.

  3. Execute the registry file.

  4. Create a Groove workspace with a workspace version of 2010 and add the add-in tool to the workspace.

For detailed instructions about how to run the samples, see Running the Sample Tools.

QuerySample Sample

QuerySample provides an example of dynamic queries where the user selects the conditions using controls in the tool's Home tab. During the first initialization of the tool after it was added to a workspace, the tool loads and commits a set of sample data. The user can then filter and sort the data by using the ribbon controls.

This sample shows how to use dynamic queries to access and filter data.  This sample also shows how to query for a subset of the tool's records. This sample demonstrates the following:

  • Dynamic queries

  • Ribbon (advanced)

  • Indexes

PhotosWPF Sample

PhotosWPF is a basic photo-sharing sample using the Windows Presentation Foundation (WPF).  A user can add photos to the tool and delete photos from it. When the user selects a photo in the list, the tool displays the photo in the main area of the control.

This sample shows how to implement data-bound WPF controls in an add-in tool. It focuses on attachments, events, and dynamically updating the stored dataset without refreshing the whole dataset. This sample demonstrates the following:

  • Ribbon (Basic)

  • WPF

  • Attachments

  • Events

AttachmentsAndConflicts Sample

AttachmentsAndConflicts allows you to create, edit, and delete records describing an event, such as a conference. To avoid confusion with programmatic events describing data changes, the term "conference event" is used in this section. Each record describes a conference event with a name, date, location, and notes. You can add a new conference event using the Add button in the ribbon, which will let you fill out the properties of the conference event.  When a conference event is selected, the user can decide to add or delete attachments. When conflicting edits are made from two members at the same time, a conflict icon will appear on the data record in conflict (either data row or attachment row).  When this record is selected, a Resolve Conflict button appears on the ribbon. This will open a dialog letting the user select which record to save.

This sample focuses on conflicts, attachments, ContentState of attachments, and data change events. This sample demonstrates the following:

  • Ribbon (intermediate)

  • Conflicts

  • Attachments

    • ContentState

    • Launch

    • Update

  • Events

Visual Studio Project

The Visual Studio project is provided in the following file:

  • SPWAddinTemplate.zip

Documentation

The documentation is contained in the following files:

  • SPW14SDKCon.chm—Contains the Release Notes and Reference SDK documentation.

  • SPW14SDK.chm—Contains the Class Library Reference for the API.