1 out of 2 rated this helpful Rate this topic

Using the Silverlight Object Model

SharePoint 2010

Published: May 2010

Microsoft SharePoint Foundation 2010 supports implementation of the Silverlight client object model in two contexts: within a Silverlight Web Part, and within the Silverlight Cross-Domain Data Access system, through which a Silverlight application interacts with Microsoft SharePoint Foundation 2010 data. A third possibility--modifying client access cross-domain policy on the server--opens security risks and is not supported in SharePoint Foundation 2010.

Because query execution is asynchronous when you use the SharePoint Foundation Silverlight object model, you must pass delegates for callback methods as parameters in the ExecuteQueryAsync(ClientRequestSucceededEventHandler, ClientRequestFailedEventHandler) method, similarly to query execution in the JavaScript object model. However, to run code that makes changes in the user interface (UI) through the Silverlight object model, you must delegate this work to the Dispatcher object of the thread that created the UI by calling BeginInvoke, as seen in the following examples.

Deploying code through a Silverlight Web Part

To use the SharePoint Foundation Silverlight object model within a Silverlight Web Part, you can create a Silverlight application in Visual Studio, and add your code to the Page class in the default Page.xaml.cs file of your project. After you build your project, upload the project's application package (.xap) file to a document library. Insert a Silverlight Web Part into a Web Parts page and point the URL source of the Web Part to the .xap file in the document library.

The following examples assume the definitions of a Button control and a TextBlock control in the MainPage.xml file of the project.

Retrieving list data

The following example shows how to retrieve SharePoint Foundation data within the context of a Silverlight application. The example involves using event handlers for success or failure of query execution. The onQuerySucceeded method creates a delegate, UpdateUIMethod, to display returned list data in the UI.

Copy

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Microsoft.SharePoint.Client;
 
namespace Microsoft.SDK.SharePointServices.Samples
{
    public partial class MainPage : UserControl
    {
        Web oWebsite;
        ListCollection collList;
        IEnumerable<List> listInfo;
 
        public MainPage()
        {
            InitializeComponent();
        }
 
        private void Button_Click(object sender, RoutedEventArgs e)
        {
            ClientContext clientContext = ClientContext.Current;
            oWebsite = clientContext.Web;
            ListCollection collList = oWebsite.Lists;
 
             clientContext.Load(oWebsite,
                website=>website.Title);
 
             listInfo = clientContext.LoadQuery(
                collList.Include(
                    list=>list.Title,
                    list=>list.Fields.Include(
                        field=>field.Title).Where(
                        field=>field.Required  == true
                        && field.Hidden != true)));
 
            clientContext.ExecuteQueryAsync(onQuerySucceeded, onQueryFailed);
        }
 
        private void onQuerySucceeded(object sender, ClientRequestSucceededEventArgs args)
        {
            UpdateUIMethod updateUI = DisplayInfo;
            this.Dispatcher.BeginInvoke(updateUI);
        }
 
        private void onQueryFailed(object sender, ClientRequestFailedEventArgs args)
        {
            MessageBox.Show = "Request failed. " + args.Message + "\n" + args.StackTrace;
        }
 
        private void DisplayInfo()
        {
            MyOutput.Text = "Title: " + oWebsite.Title;
            collList = oWebsite.Lists;
 
            foreach (List oList in listInfo)
            {
                MyOutput.Text += "\n\tList: " + oList.Title;
 
                FieldCollection collField = oList.Fields;
                foreach (Field oField in collField)
                {
                    MyOutput.Text += "\n\t\tField: " + oField.Title;
                }
            }
        }
 
        private delegate void UpdateUIMethod();
    }
}

The previous example uses the Current property to specify the current request context, instead of using the ClientContext(String) constructor and specifying a URL. You can upload, for example, the .xap file to Shared Documents in the root Web site of the site collection, and create a Web Parts page in a child Web site anywhere beneath the root Web site, and add a Silverlight Web Part to this page that points to the .xap file and therefore implements its logic. In other words, your code might live in the root Web site, but its logic becomes available to any Web site in the site collection.

Creating a list item

The following example shows how to create a list item in a specific list. The example uses a delegate to display information about the new item in the UI.

Copy

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Microsoft.SharePoint.Client;

namespace Microsoft.SDK.SharePointServices.Samples
{
    public partial class MainPage : UserControl
    {
        private List oList;
        private string siteUrl = "http://MyServer/sites/MySiteCollection/MyWebSite";

        public MainPage()
        {
            InitializeComponent();
        }

        private void Button_Click(object sender, RoutedEventArgs e)
        {
            ClientContext clientContext = new ClientContext(siteUrl);
            Web oWebsite = clientContext.Web;
            ListCollection collList = oWebsite.Lists;

            oList = clientContext.Web.Lists.GetByTitle("Announcements");

            ListItem oListItem = oList.AddItem(new ListItemCreationInformation());
            oListItem["Title"] = "My new item";
            oListItem["Body"] = "This is my new Silverlight item.";
            oListItem.Update();

            clientContext.Load(oList,
                list => list.Title);

            clientContext.ExecuteQueryAsync(onQuerySucceeded, onQueryFailed);
        }

        private void onQuerySucceeded(object sender, ClientRequestSucceededEventArgs args)
        {
            UpdateUIMethod updateUI = DisplayInfo;
            this.Dispatcher.BeginInvoke(updateUI);
        }

        private void DisplayInfo()
        {
            MyOutput.Text = "New item created in " + oList.Title;
        }

        private delegate void UpdateUIMethod(); 
        
        private void onQueryFailed(object sender, ClientRequestFailedEventArgs args)
        {
            MessageBox.Show("Request failed. " + args.Message + "\n" + args.StackTrace);
        }
    }
}

Concepts

Code Sample: Silverlight List Viewer

Data Retrieval Overview

SharePoint 2010 Client Object Model Guidelines

How to: Retrieve Lists

How to: Create, Update, and Delete List Items

Common Programming Tasks in the Managed Client Object Model

Other Resources

Client Class Library

JavaScript Class Library

Change History

Date	Description	Reason
May 2010	Initial publication

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(2000 characters remaining)

Community Content Add

FAQ

Not able to add Microsoft.Sharepoint.Client object

Hi,

I am not able to add Microsoft.Sharepoint.Client object as a reference in Silverlight Project.

History

12/30/2010
Balaji_rcs

8/24/2011
Michael M. Bangoy

Examples of adding documents to libraries

The list items examples are fairly good, but there are no examples on handling files (getting the files and URL is no big deal, adding them from a SL app using the SP2010 SL COM is the issue I'm trying to find) that I could find. If someone could add documentation to do so or point me to links for reference, it would be much appreciated.

History

11/19/2010
Chad Beard

Retrieving List Item

Hi,

I'm attempting to access List Item field values via the Client Object Model. I'm not sure that I understand the process correctly. I'm retrieving fiels via the the managed include accessor as the example illistrates using Linq to Objects.

I am able to retrieve Id and DisplayName using the following syntax :

clientContext.Load(collListItem,
items => items.Include(
item => item.Id,
item => item.DisplayName));

However, when I attempt to retrieve other field values in the list for instance the 'URL' field, which I know exists ( You can see this by browsing to the list and exploring the field names used) via the following method

...
item => item.Id,
item => item.DisplayName,
item => item["URL"]));

I get an exception : "Invalid cross-thread access"

When I remove the ",item => item["URL"]" section the query executes successfully.

Can anyone tell me how I have to go about retrieving field values in lists and if there is an option to retrieve ALL fields in the ListItem by default?

Regards,
Pieter Theron

History

10/4/2010
Pieter Theron

Retrieve Incorrect Date Time Field value

hello , i am using client object model with sliverlight application, i connect to my custom list that have some field ( CustomerName of type string , ContractDate of type DateTime), $0I make a Query that get all items from the list, the problem is when i get the ContractDate it came decremented by 1 day . $0 Example : the list has Michael 24/10/1985 Mark1/2/1980 the query returns Michael 23/10/1985 Mark 1/2/1980$0 $0please help me to find out the strange problem ?????????????? thanks in adavance$0$0

History

8/16/2010
Michael Nagy

8/16/2010
Michael Nagy

Retrieve Incorrect Date Time Field value

hello , $0i am using client object model with sliverlight application, i connect to my custom list that have some field ( CustomerName of type string , ContractDate of type DateTime), i make a Query that get all items from the list, the problem is when i get the ContractDate it came decremented by 1 day . $0 $0example : $0 $0the list has $0 $0Michael24/10/1985$0 $0Mark1/2/1980$0 $0$0 $0 $0the query returns $0 $0Michael23/10/1985$0 $0Mark1/2/1980$0 $0$0 $0 $0please help me to find out the strange problem ??????????????//$0 $0$0 $0 $0thanks in adavance$0

History

8/16/2010
Michael Nagy

@Zafer

You are correct. The Client Object Model is new in SharePoint 2010.

History

4/6/2010
Nathaniel Granor

Microsoft.SharePoint.Client

why do i have a feeling that Microsoft.SharePoint.Client assembly doesnt exist in moss 2003 and im using vs 2008

ive create my sliverlight app but i want to do something that affects sharepoint, and i cant find that Microsoft.SharePoint.Client dll to reference it

any help

History

3/15/2010
zafer_510

Accessing content type in Silverlight application ????

Hello,
I am creating a silverlight application and deploying it as a feature on sharepoint using client object model.Can anybody tell me how to retrieve all list in a site which contains a particular type of content type.E.g if custom content type - "My Content Type" is used in different lists in a site then i want to retrieve all these lists in silver light application.
Please reply to this query as i need it urgently...
Thanks.

History

2/22/2010
ursYash

Error in first example

The line: MessageBox.Show = "Request failed. " + args.Message + "\n" + args.StackTrace;

Should be: MessageBox.Show("Request failed. " + args.Message + "\n" + args.StackTrace);

History

2/5/2010
emaurer