Interface IDocumentSet

Public interface to define a Document Set.

Inherited Members
Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface IDocumentSet : IDataModel<IDocumentSet>, IDataModelParent, IDataModelWithContext, ISupportModules<IDocumentSet>

Properties

AllowedContentTypes

Content types allowed in document set.

Declaration
IList<IContentTypeInfo> AllowedContentTypes { get; set; }
Property Value
PnP.Core.Model.SharePoint.IList<IContentTypeInfo>

ContentTypeId

Content Type Id

Declaration
string ContentTypeId { get; set; }
Property Value
System.String

DefaultContents

Default contents of document set.

Declaration
IList<IDocumentSetContent> DefaultContents { get; set; }
Property Value
PnP.Core.Model.SharePoint.IList<IDocumentSetContent>

SharedColumns

Columns edited on the document set that synchronize to all documents in the set. These are read-only on the documents themselves.

Declaration
IList<IField> SharedColumns { get; set; }
Property Value
PnP.Core.Model.SharePoint.IList<IField>

ShouldPrefixNameToFile

Indicates whether to add the name of the document set to each file name.

Declaration
bool ShouldPrefixNameToFile { get; set; }
Property Value
System.Boolean

WelcomePageColumns

Specifies columns to show on the welcome page for the document set.

Declaration
IList<IField> WelcomePageColumns { get; set; }
Property Value
PnP.Core.Model.SharePoint.IList<IField>

WelcomePageUrl

Welcome page absolute URL.

Declaration
string WelcomePageUrl { get; set; }
Property Value
System.String

Methods

Update(DocumentSetOptions)

Updates the document set

Declaration
IDocumentSet Update(DocumentSetOptions options)
Parameters
DocumentSetOptions options

Returns
IDocumentSet

UpdateAsync(DocumentSetOptions)

Updates the document set

Declaration
Task<IDocumentSet> UpdateAsync(DocumentSetOptions options)
Parameters
DocumentSetOptions options

Returns
Task<IDocumentSet>

Extension Methods