10+ Useful SharePoint Client Object Model Methods

-
Following the console SharePoint COM app we created previously. Now I will show you how to create other useful methods.

First Open Visual Studio and create an empty C# Console application, name it SP_COMapp.

Add references to Microsoft.SharePoint.Client and Microsoft.SharePoint dlls. (found in Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\ISAPI\ folder)

Your Program.cs should have something like this


using Microsoft.SharePoint.Client;
using Microsoft.SharePoint;

Next make sure the reference Copy Local property for these dlls are set to True. (Solution Explorer > Expand References > Click the references > Properties Window > Copy Local > True)
Ok now we're good to go. The namespace region should look like this. 
namespace SP_COMapp
{
    class Program
    {

 static void Main(string[] args)
        {

        }
     }

}

Now our COM methods will be as follows:
List Sites place this inside the Program region not on the main, we'll get back on the main for later ;) 
public static void ListSite()
                {
                    using (ClientContext context = new ClientContext("http://sharepointserver"))
                    {
                        context.Credentials = new NetworkCredential("admin", "password"); //security purposes
                        WebCollection web = context.Web.Webs;
                        context.Load(web);
                        context.ExecuteQuery();
                        Console.WriteLine("--------------------------------------------------------------- \n");
                        int i = 0;
                        foreach (Web website in web)
                        {
                            i++;
                            Console.WriteLine(i + "\t" + website.Title + "\t\t" + website.ServerRelativeUrl);
                        }
                    }
                }

Get Templates 
public static void GetSiteTemplates()
                {
                    using (ClientContext clientContext = new ClientContext("http://sharepointserver"))
                    {
                        clientContext.Credentials = new NetworkCredential("admin", "password");
                        Web oWebsite = clientContext.Web;
                        uint tempLCID = 1033;
                        Boolean tempBol = true;
                        WebTemplateCollection oTempColl = oWebsite.GetAvailableWebTemplates(tempLCID, tempBol);
                        clientContext.Load(oTempColl);
                        clientContext.ExecuteQuery();
                        Console.WriteLine("--------------------------------------------------------------- \n");
                        foreach (WebTemplate oTemplate in oTempColl)
                        {
                            Console.WriteLine(oTemplate.Id + "\t" + oTemplate.Name + "\t\t" + oTemplate.Title);
                        
                        }
                    }


                }

Get List Items 
public static void DisplayList() {
            using (ClientContext clientContext = new ClientContext("http://devspoint2010"))
            {
                clientContext.Credentials = new NetworkCredential("admin", "password");
                Web oWebsite = clientContext.Web;
                List oList = oWebsite.Lists.GetByTitle("Shared Documents");
                var files = oList.RootFolder.Files;
                clientContext.Load(files);
                clientContext.ExecuteQuery();
                String sb = "";
                Console.WriteLine("--------------------------------------------------------------- \n");
                for (int i = 0; i < files.Count; i++)
                {
                    sb = sb + files[i].Name + "\n";
                }
                Console.WriteLine(sb);
            }
           
        
        }

Get List of Contacts using CAML Query 

public static void ListContacts() {
                    using (ClientContext context = new ClientContext("http://sharepointserver"))
                    {
                        context.Credentials = new NetworkCredential("admin", "password");
                        Web web = context.Web;

                        List list = web.Lists.GetByTitle("Contact");
                        CamlQuery query = new CamlQuery();
                        query.ViewXml = "";
                        ListItemCollection listItems = list.GetItems(query);
                        context.Load(listItems);
                        context.ExecuteQuery();
                        Console.WriteLine("--------------------------------------------------------------- \n");
                        foreach (Microsoft.SharePoint.Client.ListItem oitem in listItems) {
                            Console.WriteLine(oitem["Title"] + "\t" + oitem["FirstName"] + "\t" + oitem["Email"]);
                        }
                       
                    }
            
                
                }

Get List of Tasks 
 public static void ListTasks()
                {
                    using (ClientContext context = new ClientContext("http://sharepointserver"))
                    {
                        context.Credentials = new NetworkCredential("admin", "password");
                        Web web = context.Web;

                        List list = web.Lists.GetByTitle("Tasks");
                        CamlQuery query = new CamlQuery();
                        query.ViewXml = "";
                        ListItemCollection listItems = list.GetItems(query);
                        context.Load(listItems);
                        context.ExecuteQuery();
                        Console.WriteLine("--------------------------------------------------------------- \n");
                        foreach (Microsoft.SharePoint.Client.ListItem oitem in listItems)
                        {
                            Console.WriteLine(oitem["Title"] + "\t" + oitem["Status"] + "\t" + oitem["Priority"]);
                        }

                    }


                }

Get List of Events using CAML Query 
public static void ListEvents()
                {
                    using (ClientContext context = new ClientContext("http://sharepointserver"))
                    {
                        context.Credentials = new NetworkCredential("admin", "password");
                        Web web = context.Web;

                        List list = web.Lists.GetByTitle("Calendar");
                        CamlQuery query = new CamlQuery();
                        query.ViewXml = "";
                        ListItemCollection listItems = list.GetItems(query);
                        context.Load(listItems);
                        context.ExecuteQuery();
                        Console.WriteLine("--------------------------------------------------------------- \n");
                        int i = 0;
                        foreach (Microsoft.SharePoint.Client.ListItem oitem in listItems)
                        {
                            i++;
                            Console.WriteLine(i + "\t" + oitem["Title"] + "\t" + oitem["Description"]);
                            
                        }

                    }


                }

Get List of Site Groups 
public static void ShowGroups()
                {

                    using (ClientContext context = new ClientContext("http://sharepointserver"))
                    {

                        context.Credentials = new NetworkCredential("admin", "password");
                        Web oWeb = context.Web;
                        GroupCollection oGroupColl = oWeb.SiteGroups;
                        context.Load(oGroupColl);
                        context.ExecuteQuery();
                        Console.WriteLine("--------------------------------------------------------------- \n");
                        foreach (Group grp in oGroupColl) {
                            Console.WriteLine(grp.Id + "\t" + grp.Title);
                        }
                        Console.WriteLine("\n");
                    }

                }

Get List of Site Users 
 public static void ShowUsers()
                {

                    using (ClientContext context = new ClientContext("http://sharepointserver"))
                    {

                        context.Credentials = new NetworkCredential("admin", "password");
                        Web oWeb = context.Web;
                        CamlQuery query = new CamlQuery();
                        query.ViewXml = "";
                        var oUsrColl = oWeb.SiteUserInfoList.GetItems(query);
                        context.Load(oUsrColl);
                        context.ExecuteQuery();
                        Console.WriteLine("--------------------------------------------------------------- \n");
                        foreach (Microsoft.SharePoint.Client.ListItem oitem in oUsrColl)
                        {
                            Console.WriteLine(oitem.Id + "\t" + oitem["Title"]);
                        }
                        Console.WriteLine("\n");
                    }

Create Site/Page 
public static void CreateSite() {

            string blogDescription = "New COM Sample site.";
            int blogLanguage = 1033;
            string blogTitle = "Sample Site from COM demo";
            string blogUrl = "SP00";
            bool blogPermissions = false;
            string webTemplate = "STS#0";
            using (ClientContext context = new ClientContext("http://sharepointserver"))
            {
                Web web = context.Web;
                context.Credentials = new NetworkCredential("admin", "password");
                WebCreationInformation webCreateInfo = new WebCreationInformation();
                webCreateInfo.Description = blogDescription;
                webCreateInfo.Language = blogLanguage;
                webCreateInfo.Title = blogTitle;
                webCreateInfo.Url = blogUrl;
                webCreateInfo.UseSamePermissionsAsParentSite = blogPermissions;
                webCreateInfo.WebTemplate = webTemplate;

                Web oNewWebsite = web.Webs.Add(webCreateInfo);

                context.Load(
                    oNewWebsite,
                    website => website.ServerRelativeUrl,
                    website => website.Created);

                context.ExecuteQuery();
                Console.WriteLine("Success!! \n");
            }
            
        
        }

File Upload 
public static void UploadDocument()
        {
            string documentListName;
            string documentName;
            byte[] documentStream;
            documentListName = "Shared Documents";
            documentName = "sample.txt";
            documentStream = GetBytesFromFile("C:\\sample.txt");

            using (ClientContext clientContext = new ClientContext("http://sharepointserver"))
            {
                clientContext.Credentials = new NetworkCredential("admin", "password");
                List documentsList = clientContext.Web.Lists.GetByTitle(documentListName);

                var fileCreationInformation = new FileCreationInformation();

                fileCreationInformation.Content = documentStream;

                fileCreationInformation.Overwrite = true;

                fileCreationInformation.Url = "http://sharepointserver/" + documentListName + "/" + documentName;
                Microsoft.SharePoint.Client.File uploadFile = documentsList.RootFolder.Files.Add(
                    fileCreationInformation);

                uploadFile.ListItemAllFields.Update();
                clientContext.ExecuteQuery();
                Console.WriteLine("Success!! \n");

            }
        }
public static byte[] GetBytesFromFile(string fullFilePath)
        {
            FileStream fs = System.IO.File.OpenRead(fullFilePath);
            try
            {
                byte[] bytes = new byte[fs.Length];
                fs.Read(bytes, 0, Convert.ToInt32(fs.Length));
                fs.Close();
                return bytes;
            }
            finally
            {
                fs.Close();
            }

        }

Create Contact Item 
public static void CreateContact() {

            using (ClientContext context = new ClientContext("http://sharepointserver"))
            {
                context.Credentials = new NetworkCredential("admin", "password");
                Web web = context.Web;

                List list = web.Lists.GetByTitle("Contact");

                ListItemCreationInformation newItem = new ListItemCreationInformation();
                Microsoft.SharePoint.Client.ListItem listItem = list.AddItem(newItem);
                listItem["Title"] = "Tester";
                listItem["FirstName"] = "Admin";
                listItem["Email"] = "admin@sharepointserver";
                listItem["Company"] = "Contoso";
                listItem.Update();
                context.ExecuteQuery();
                Console.WriteLine("Success!! \n");
            }
            

        }

Create Task Item 

public static void CreateTask() {
 using (ClientContext context = new ClientContext("http://sharepointserver"))
            {
                context.Credentials = new NetworkCredential("admin", "password");
                Web web = context.Web;

                List list = web.Lists.GetByTitle("Tasks");
                ListItemCreationInformation newItem = new ListItemCreationInformation();
                Microsoft.SharePoint.Client.ListItem listItem = list.AddItem(newItem);
                listItem["Title"] = "Item Created through C# Console";
                listItem.Update();
                context.ExecuteQuery();
                Console.WriteLine("Success!! \n");
            }

Create Event Item 
public static void CreateEvent() {
 using (ClientContext context = new ClientContext("http://sharepointserver"))
            {
                context.Credentials = new NetworkCredential("admin", "password");
                Web web = context.Web;

                List list = web.Lists.GetByTitle("Calendar");

                ListItemCreationInformation newItem = new ListItemCreationInformation();
                Microsoft.SharePoint.Client.ListItem listItem = list.AddItem(newItem);
                listItem["Title"] = "New Event Created through C# Console";
                listItem["EventDate"] = DateTime.Now;
                listItem["EndDate"] = DateTime.Now.AddHours(1);
                listItem["Description"] = "Test Event from C# Console COM app";
                listItem.Update();
                context.ExecuteQuery();
                Console.WriteLine("Success!! \n");
            }
        }

Create Document Folder 
public static void CreateFolder() {
 using (ClientContext context = new ClientContext("http://sharepointserver"))
            {
                context.Credentials = new NetworkCredential("admin", "password");
                Web oWebsite = clientContext.Web;
                List oList = oWebsite.Lists.GetByTitle("Shared Documents");
                if (oList != null)
                {
                    String folder = "Sample Folder";
                    var folders = oList.RootFolder.Folders;
                    clientContext.Load(folders);
                    clientContext.ExecuteQuery();
                    var newFolder = folders.Add(folder);
                    clientContext.ExecuteQuery();
                    Console.WriteLine("Success!! \n");
                }
            }
        }

Update Task Item using CAML Query the same rule applies to contacts/events list. 
public static void UpdateTask() {
 using (ClientContext context = new ClientContext("http://sharepointserver"))
            {
                context.Credentials = new NetworkCredential("admin", "password");
                List list = context.Web.Lists.GetByTitle("Tasks");
                CamlQuery query = new CamlQuery();
                query.ViewXml = "New Event Created through C# Console";
                ListItemCollection listItems = list.GetItems(query);
                context.Load(listItems);
                context.ExecuteQuery();
                Microsoft.SharePoint.Client.ListItem item = listItems[listItems.Count - 1];
                item["Status"] = "In Progress";
                item.Update();
                context.ExecuteQuery();
                Console.WriteLine("Success!! \n");
            }
            
        }

Update Site/Page 
public static void UpdateSite()
        {
using (ClientContext context = new ClientContext("http://sharepointserver/sample00")) //exact url of the site/page
            {
                context.Credentials = new NetworkCredential("admin", "password");
                Web oWebsite = clientContext.Web;
                oWebsite.Description = "Updated Site from Console App";
                oWebsite.Update();
                clientContext.Load(oWebsite);
                clientContext.ExecuteQuery();
                Console.WriteLine("Success!! \n");
            }


        }

Delete Task Item using CAML Query same rule applies to contacts/events list. 
public static void DeleteTask() {
 using (ClientContext context = new ClientContext("http://sharepointserver/sample00")) 
            {
                context.Credentials = new NetworkCredential("admin", "password");
                List list = context.Web.Lists.GetByTitle("Tasks");
                CamlQuery query = new CamlQuery();
                query.ViewXml = "New Event Created through C# Console";
                ListItemCollection listItems = list.GetItems(query);
                context.Load(listItems);
                context.ExecuteQuery();
                listItems[listItems.Count - 1].DeleteObject();
                context.ExecuteQuery();
                Console.WriteLine("Success!! \n");
            }
        
        }

Invoke any of these in the main region, but first make sure that all the list you're trying to access are already created. 
static void Main(string[] args)
        {
 CreateSite();
 }


Alright! That's it for now! Next post I will show you how to do search and using the SharePoint web services for our COM Application. Ka-ciao! ;)

Comments

Post a Comment

Popular posts from this blog

Setting up TMS Web Planner and Access Database [TMS Tut Part 1]

-
First: create the database named Planner.accdb, create a table named Scheduler inside with the ff fields: Field:  ID             Type: AutoNumber Field:  Subject     Type: Text Field:  Notes       Type: Text Field:  StartTime  Type: Date/Time Field:  EndTime   Type: Date/Time We will add necessary fields later. As for now that would do fine for a prototype. Second: create an empty C# web application project in Visual Studio. Make sure your TMS Web Planner Controls has already been integrated with Visual Studio Toolbox. On your solution explorer right click and create a new folder named "Planner", add an empty ASP item on that folder name it "Planner.aspx" Right-click on Planner.aspx file and select design. Drag and drop an Access DataSource object under Toolbox on Visual Studio. Now configure the Access DataSource and connect it to the Planner.accdb file. I suggest you put the acc...
Read more

Converting JSON API returned data into 2016 SQL table rows

-
Image
To start the setup you must have the 2016 version of SQL Server(or higher version) Create the table beforehand along w/ desired columns(sample columns added) Fetch API data w/ POSTMAN chrome extension tool or simply use your API fetching custom app to retrieve the data(browser will do too) In SQL Server 2016 create new query to your db > table Copy > Paste the following script DECLARE @json NVARCHAR(MAX) SET @json = N'[<json>]' INSERT INTO <table> SELECT * FROM OPENJSON ( @json ) WITH ( <fields> ) where <json> is the returned data from POSTMAN/browser, <table> is the SQL table to which you want the data to be added, <fields> would be the matching fields we add from JSON to SQL column an example for this with exact sample values would be: DECLARE @json NVARCHAR(MAX) SET @json = N'[ { "Order": { "Number":"SO43659", "Date":"2011-05-31...
Read more

OOTB Valvrave III Hikaminari 1/144 Review

-
Image
This week I finally got a hold of this Valvrave kit: Now I'm gonna show you a quick review on this amazing mecha. First I've built the kit out of the box a day ago, so now I'm gonna take off the removable parts and let you peak through of what it looks like ;) By the way here are the size comparisons, size against a 1/144 G-Exes: Pretty big compared to most 1/144 right? Let see the size compared to an 1/100 MG Aile Strike: Aha! the Aile Strike Head is much taller than the Hikaminari Head, but the overall kit is pretty much the same or taller than the Aile. Sweet! :) Alright! Now we're moving on to the parts! yay! I've removed the important pieces so you can see which of them can be detached/attached. To enumerate you have 2x Armstronger, 2x Arms, 2x Legs, 2x Chain Saucer, 2x Dai Arms, 1x Head, 1x Chest, 1x Hip We will start checking out the head first ;) As you can see it doesn't have too many pieces. The left and right face are to be snap f...
Read more