What’s new in SharePoint 2016 CSOM (DocumentSets)

11 March 2016 Robrecht-Van-Caenegem SharePoint 2016, SharePoint Development

With SharePoint 2016 RC available, it’s interesting to see what new additions we have in CSOM and/or REST APIs. Doing some research in the differences between the SharePoint 2013 RTM CSOM and SharePoint 2016 RC CSOM, I noticed several differences. This post will describe the differences related to DocumentSets.

In SharePoint 2013, the only thing you could do with document sets from within CSOM was to create one, given a parent folder, name and the contenttype id of the document set. You weren’t able to do anything else.

So what’s new? You’re now also able to do the following things:

  • Create/alter the contenttype definition of a documentset contenttype.
  • Get a document set based on a listitem/folder.
  • Export a document set to a zip file (I mean OpenXML file).
  • Import a document set from a zip file (again … OpenXML file).

image

DocumentSetTemplate

There is a new class available that allows you to change the definition of a documentset contenttype. It gives you access to the SharedFields, Templates, AllowedContentTypes, …
You can use it as follows:

var documentSetTemplate = DocumentSetTemplate.GetDocumentSetTemplate(ctx, ct);
documentSetTemplate.AllowedContentTypes.Add(ct_document.Id);
documentSetTemplate.DefaultDocuments.Add("template.odt", ct_document.Id, bytes);
documentSetTemplate.SharedFields.Add(field_customer);
documentSetTemplate.WelcomePageFields.Add(field_customer);
documentSetTemplate.Update(true);
ctx.ExecuteQuery();

Where ct and ct_document are respectively a documentset contenttype and a document contenttype.

Unfortunately, you’re still not able to directly set the default document set view, nor alter the url of the docsethomepage.aspx.

Export Document Set

You can now export a documentset to an OpenXML (zip) file as follows:

ListItem item = GetDocumentSet(...); // DocumentSet item
ctx.Load(item, it => it.Folder);
ctx.ExecuteQuery();

var documentSet = DocumentSet.GetDocumentSet(ctx, item.Folder);
ctx.Load(documentSet);
ctx.ExecuteQuery();

var stream = documentSet.ExportDocumentSet();
ctx.ExecuteQuery();
using(FileStream fs = new FileStream("docset.zip", FileMode.Create, FileAccess.Write, FileShare.None))
{
    stream.Value.CopyTo(fs);
}

Result:

image

Import Document Set

You can now import an exported document set as follows:

using(FileStream fs = new FileStream("docset.zip", FileMode.Open, FileAccess.Read, FileShare.None))
{
    DocumentSet docSet = DocumentSet.ImportDocumentSet(ctx, fs, "Imported", list.RootFolder, ct.Id);
    ctx.ExecuteQuery();
}

Result:

image

Tags :