Class DocumentSetTemplate

Defines a DocumentSet Template for creating multiple DocumentSet instances

Inheritance
System.Object
BaseModel
DocumentSetTemplate
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class DocumentSetTemplate : BaseModel, IProvisioningTemplateDescendant

Constructors

DocumentSetTemplate()

Constructor for DocumentSetTemplate class

Declaration
public DocumentSetTemplate()

DocumentSetTemplate(String, IEnumerable<ContentTypeReference>, IEnumerable<DefaultDocument>, IEnumerable<FieldReference>, IEnumerable<FieldReference>)

Constructor for DocumentSetTemplate class

Declaration
public DocumentSetTemplate(String welcomePage, IEnumerable<ContentTypeReference> allowedContentTypes = null, IEnumerable<DefaultDocument> defaultDocuments = null, IEnumerable<FieldReference> sharedFields = null, IEnumerable<FieldReference> welcomePageFields = null)
Parameters
String welcomePage

Welcome Page of the DocumentSet
IEnumerable<ContentTypeReference> allowedContentTypes

Content Types allowed for the DocumentSet
IEnumerable<DefaultDocument> defaultDocuments

Default documents for the DocumentSet
IEnumerable<FieldReference> sharedFields

Shared Fields for the DocumentSet
IEnumerable<FieldReference> welcomePageFields

Welcome Page Fields for the DocumentSet

DocumentSetTemplate(String, IEnumerable<String>, IEnumerable<DefaultDocument>, IEnumerable<Guid>, IEnumerable<Guid>)

Constructor for DocumentSetTemplate class

Declaration
public DocumentSetTemplate(String welcomePage, IEnumerable<String> allowedContentTypes = null, IEnumerable<DefaultDocument> defaultDocuments = null, IEnumerable<Guid> sharedFields = null, IEnumerable<Guid> welcomePageFields = null)
Parameters
String welcomePage

Welcome Page of the DocumentSet
IEnumerable<String> allowedContentTypes

Content Types allowed for the DocumentSet
IEnumerable<DefaultDocument> defaultDocuments

Default documents for the DocumentSet
IEnumerable<Guid> sharedFields

Shared Fields for the DocumentSet
IEnumerable<Guid> welcomePageFields

Welcome Page Fields for the DocumentSet

Properties

AllowedContentTypes

The list of allowed Content Types for the Document Set

Declaration
public ContentTypeReferenceCollection AllowedContentTypes { get; }
Property Value
ContentTypeReferenceCollection

DefaultDocuments

The list of default Documents for the Document Set

Declaration
public DefaultDocumentCollection DefaultDocuments { get; }
Property Value
DefaultDocumentCollection

RemoveExistingContentTypes

The RemoveExistingContentTypes flag for the Allowed Content Types of the current Document Set, optional attribute.

Declaration
public Boolean RemoveExistingContentTypes { get; set; }
Property Value
Boolean

SharedFields

The list of Shared Fields for the Document Set

Declaration
public FieldReferenceCollection SharedFields { get; }
Property Value
FieldReferenceCollection

UpdateChildren

Declares whether changes to the content type will be udpated on inherited content types, optional attribute.

Declaration
public Boolean UpdateChildren { get; set; }
Property Value
Boolean

WelcomePage

Defines the custom WelcomePage for the Document Set

Declaration
public String WelcomePage { get; set; }
Property Value
String

WelcomePageFields

The list of Welcome Page Fields for the Document Set

Declaration
public FieldReferenceCollection WelcomePageFields { get; }
Property Value
FieldReferenceCollection

XmlDocuments

Gets a value that specifies the XML Documents settings for the Document Set. https://msdn.microsoft.com/en-us/library/office/aa543904.aspx

Declaration
public XElement XmlDocuments { get; set; }
Property Value
XElement

Methods

Equals(DocumentSetTemplate)

Compares DocumentSetTemplate object based on AllowedContentTypes, DefaultDocuments, SharedFields, WelcomePageFields, RemoveExistingContentTypes, XmlDocuments, and UpdateChildren properties.

Declaration
public bool Equals(DocumentSetTemplate other)
Parameters
DocumentSetTemplate other

DocumentSetTemplate object
Returns
System.Boolean

true if the DocumentSetTemplate object is equal to the current object; otherwise, false.

Equals(Object)

Compares object with DocumentSetTemplate

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Object that represents DocumentSetTemplate
Returns
System.Boolean

true if the current object is equal to the DocumentSetTemplate

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods