Interface IDocumentSet

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Public interface to define a Document Set.

public interface IDocumentSet : IDataModel<IDocumentSet>, IDataModelParent, IDataModelWithContext, ISupportModules<IDocumentSet>

Inherited Members

IDataModel<IDocumentSet>.Requested

IDataModel<IDocumentSet>.HasValue(string)

IDataModel<IDocumentSet>.HasChanged(string)

IDataModel<IDocumentSet>.IsPropertyAvailable(Expression<Func<IDocumentSet, object>>)

IDataModel<IDocumentSet>.ArePropertiesAvailable(params Expression<Func<IDocumentSet, object>>[])

IDataModel<IDocumentSet>.EnsureProperties(params Expression<Func<IDocumentSet, object>>[])

IDataModel<IDocumentSet>.EnsurePropertiesAsync(params Expression<Func<IDocumentSet, object>>[])

IDataModel<IDocumentSet>.ExecuteRequestAsync(ApiRequest)

IDataModel<IDocumentSet>.ExecuteRequest(ApiRequest)

IDataModel<IDocumentSet>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<IDocumentSet>.ExecuteRequestBatch(ApiRequest)

IDataModel<IDocumentSet>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<IDocumentSet>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

Extension Methods

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<string, string>, Action<Dictionary<string, string>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<string, string>>)

Properties

AllowedContentTypes

Content types allowed in document set.

IList<IContentTypeInfo> AllowedContentTypes { get; set; }

Property Value

IList<IContentTypeInfo>

ContentTypeId

Content Type Id

string ContentTypeId { get; set; }

Property Value

string

DefaultContents

Default contents of document set.

IList<IDocumentSetContent> DefaultContents { get; set; }

Property Value

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.

IList<IField> SharedColumns { get; set; }

Property Value

IList<IField>

ShouldPrefixNameToFile

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

bool ShouldPrefixNameToFile { get; set; }

Property Value

bool

WelcomePageColumns

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

IList<IField> WelcomePageColumns { get; set; }

Property Value

IList<IField>

WelcomePageUrl

Welcome page absolute URL.

string WelcomePageUrl { get; set; }

Property Value

string

Methods

Update(DocumentSetOptions)

Updates the document set

IDocumentSet Update(DocumentSetOptions options)

Parameters

options DocumentSetOptions

Returns

IDocumentSet

UpdateAsync(DocumentSetOptions)

Updates the document set

Task<IDocumentSet> UpdateAsync(DocumentSetOptions options)

Parameters

options DocumentSetOptions

Returns

Task<IDocumentSet>