Class ListInstance

Domain Object that specifies the properties of the new list.

Inheritance

System.Object

BaseModel

ListInstance

Inherited Members

BaseModel.ParentTemplate

Namespace: PnP.Framework.Provisioning.Model

Assembly: PnP.Framework.dll

Syntax

public class ListInstance : BaseModel, IProvisioningTemplateDescendant

Constructors

ListInstance()

Constructor for ListInstance class

Declaration

public ListInstance()

ListInstance(IEnumerable<ContentTypeBinding>, IEnumerable<View>, IEnumerable<Field>, IEnumerable<FieldRef>, List<DataRow>)

Constructor for ListInstance class

Declaration

public ListInstance(IEnumerable<ContentTypeBinding> contentTypeBindings, IEnumerable<View> views, IEnumerable<Field> fields, IEnumerable<FieldRef> fieldRefs, List<DataRow> dataRows)

Parameters

IEnumerable<ContentTypeBinding> contentTypeBindings ContentType Bindings of the list

IEnumerable<View> views Views of the list

IEnumerable<Field> fields Fields of the list

IEnumerable<FieldRef> fieldRefs FieldRefs of the list

List<DataRow> dataRows DataRows of the list

ListInstance(IEnumerable<ContentTypeBinding>, IEnumerable<View>, IEnumerable<Field>, IEnumerable<FieldRef>, List<DataRow>, Dictionary<String, String>, ObjectSecurity)

Constructor for ListInstance class

Declaration

public ListInstance(IEnumerable<ContentTypeBinding> contentTypeBindings, IEnumerable<View> views, IEnumerable<Field> fields, IEnumerable<FieldRef> fieldRefs, List<DataRow> dataRows, Dictionary<String, String> fieldDefaults, ObjectSecurity security)

Parameters

IEnumerable<ContentTypeBinding> contentTypeBindings ContentType Bindings of the list

IEnumerable<View> views View of the list

IEnumerable<Field> fields Fields of the list

IEnumerable<FieldRef> fieldRefs FieldRefs of the list

List<DataRow> dataRows DataRows of the list

Dictionary<String, String> fieldDefaults FieldDefaults of the list

ObjectSecurity security Security Rules of the list

ListInstance(IEnumerable<ContentTypeBinding>, IEnumerable<View>, IEnumerable<Field>, IEnumerable<FieldRef>, List<DataRow>, Dictionary<String, String>, ObjectSecurity, List<Folder>)

Constructor for ListInstance class

Declaration

public ListInstance(IEnumerable<ContentTypeBinding> contentTypeBindings, IEnumerable<View> views, IEnumerable<Field> fields, IEnumerable<FieldRef> fieldRefs, List<DataRow> dataRows, Dictionary<String, String> fieldDefaults, ObjectSecurity security, List<Folder> folders)

Parameters

IEnumerable<ContentTypeBinding> contentTypeBindings ContentTypeBindings of the list

IEnumerable<View> views Views of the list

IEnumerable<Field> fields Fields of the list

IEnumerable<FieldRef> fieldRefs FieldRefs of the list

List<DataRow> dataRows DataRows of the list

Dictionary<String, String> fieldDefaults FieldDefaults of the list

ObjectSecurity security Security Rules of the list

List<Folder> folders List Folders

ListInstance(IEnumerable<ContentTypeBinding>, IEnumerable<View>, IEnumerable<Field>, IEnumerable<FieldRef>, List<DataRow>, Dictionary<String, String>, ObjectSecurity, List<Folder>, List<CustomAction>)

Constructor for the ListInstance class

Declaration

public ListInstance(IEnumerable<ContentTypeBinding> contentTypeBindings, IEnumerable<View> views, IEnumerable<Field> fields, IEnumerable<FieldRef> fieldRefs, List<DataRow> dataRows, Dictionary<String, String> fieldDefaults, ObjectSecurity security, List<Folder> folders, List<CustomAction> userCustomActions)

Parameters

IEnumerable<ContentTypeBinding> contentTypeBindings ContentTypeBindings of the list

IEnumerable<View> views Views of the list

IEnumerable<Field> fields Fields of the list

IEnumerable<FieldRef> fieldRefs FieldRefs of the list

List<DataRow> dataRows DataRows of the list

Dictionary<String, String> fieldDefaults FieldDefaults of the list

ObjectSecurity security Security Rules of the list

List<Folder> folders List Folders

List<CustomAction> userCustomActions UserCustomActions of the list

Properties

ContentTypeBindings

Gets or sets the content types to associate to the list

Declaration

public ContentTypeBindingCollection ContentTypeBindings { get; }

Property Value

ContentTypeBindingCollection

ContentTypesEnabled

Gets or sets whether content types are enabled

Declaration

public bool ContentTypesEnabled { get; set; }

Property Value

System.Boolean

DataRows

Gets or sets the DataRows associated to the list

Declaration

public DataRowCollection DataRows { get; }

Property Value

DataRowCollection

DataSource

Defines a list of Data Source properties for the List Instance

Declaration

public Dictionary<String, String> DataSource { get; }

Property Value

Dictionary<String, String>

DefaultColumnValues

The Default Columne Values entries of the Folder, optional collection of elements.

Declaration

public Dictionary<String, String> DefaultColumnValues { get; }

Property Value

Dictionary<String, String>

DefaultDisplayFormUrl

Defines a value that specifies the location of the default display form for the list.

Declaration

public String DefaultDisplayFormUrl { get; set; }

Property Value

String

DefaultEditFormUrl

Defines a value that specifies the URL of the edit form to use for list items in the list.

Declaration

public String DefaultEditFormUrl { get; set; }

Property Value

String

DefaultNewFormUrl

Defines a value that specifies the location of the default new form for the list.

Declaration

public String DefaultNewFormUrl { get; set; }

Property Value

String

Description

Gets or sets the description of the list

Declaration

public string Description { get; set; }

Property Value

System.String

Direction

Defines a value that specifies the reading order of the list.

Declaration

public ListReadingDirection Direction { get; set; }

Property Value

ListReadingDirection

DocumentTemplate

Gets or sets a value that specifies the identifier of the document template for the new list.

Declaration

public string DocumentTemplate { get; set; }

Property Value

System.String

DraftVersionVisibility

Gets or sets the DraftVersionVisibility for the list

Declaration

public int DraftVersionVisibility { get; set; }

Property Value

System.Int32

EnableAttachments

Gets or sets whether attachments are enabled. Defaults to true.

Declaration

public bool EnableAttachments { get; set; }

Property Value

System.Boolean

EnableAudienceTargeting

Enables Audience Targeting for the list, optional attribute.

Declaration

public bool EnableAudienceTargeting { get; set; }

Property Value

System.Boolean

EnableClassicAudienceTargeting

Enables Classic Audience Targeting for the list, optional attribute.

Declaration

public bool EnableClassicAudienceTargeting { get; set; }

Property Value

System.Boolean

EnableFolderCreation

Gets or sets whether folder is enabled. Defaults to true.

Declaration

public bool EnableFolderCreation { get; set; }

Property Value

System.Boolean

EnableMinorVersions

Gets or sets whether minor verisioning is enabled on the list

Declaration

public bool EnableMinorVersions { get; set; }

Property Value

System.Boolean

EnableModeration

Gets or sets whether moderation/content approval is enabled on the list

Declaration

public bool EnableModeration { get; set; }

Property Value

System.Boolean

EnableVersioning

Gets or sets whether verisioning is enabled on the list

Declaration

public bool EnableVersioning { get; set; }

Property Value

System.Boolean

FieldDefaults

Defines a list of default values for the Fields of the List Instance

Declaration

public Dictionary<String, String> FieldDefaults { get; }

Property Value

Dictionary<String, String>

FieldRefs

Gets or sets the FieldRefs associated to the list

Declaration

public FieldRefCollection FieldRefs { get; }

Property Value

FieldRefCollection

Fields

Gets or sets the Fields associated to the list

Declaration

public FieldCollection Fields { get; }

Property Value

FieldCollection

Folders

Defines a collection of folders (eventually nested) that will be provisioned into the target list/library

Declaration

public FolderCollection Folders { get; }

Property Value

FolderCollection

ForceCheckout

Gets or sets whether to force checkout of documents in the library

Declaration

public bool ForceCheckout { get; set; }

Property Value

System.Boolean

Hidden

Gets or sets whether to hide the list

Declaration

public bool Hidden { get; set; }

Property Value

System.Boolean

ImageUrl

Defines a value that specifies the URI for the icon of the list, optional attribute.

Declaration

public string ImageUrl { get; set; }

Property Value

System.String

IrmExpire

Defines if IRM Expire property, optional attribute.

Declaration

public bool IrmExpire { get; set; }

Property Value

System.Boolean

IrmReject

Defines the IRM Reject property, optional attribute.

Declaration

public bool IrmReject { get; set; }

Property Value

System.Boolean

IRMSettings

Declaration

public IRMSettings IRMSettings { get; set; }

Property Value

IRMSettings

IsApplicationList

Defines a value that specifies a flag that a client application can use to determine whether to display the list, optional attribute.

Declaration

public bool IsApplicationList { get; set; }

Property Value

System.Boolean

ListExperience

Defines the current list UI/UX experience (valid for SPO only).

Declaration

public ListExperience ListExperience { get; set; }

Property Value

ListExperience

MaxVersionLimit

Gets or sets the MinorVersionLimit for verisioning, just in case it is enabled on the list

Declaration

public int MaxVersionLimit { get; set; }

Property Value

System.Int32

MinorVersionLimit

Gets or sets the MinorVersionLimit for versioning, just in case it is enabled on the list

Declaration

public int MinorVersionLimit { get; set; }

Property Value

System.Int32

NoCrawl

Defines if the current list or library has to be included in crawling, optional attribute.

Declaration

public Boolean NoCrawl { get; set; }

Property Value

Boolean

OnQuickLaunch

Gets or sets a value that specifies whether the new list is displayed on the Quick Launch of the site.

Declaration

public bool OnQuickLaunch { get; set; }

Property Value

System.Boolean

PropertyBagEntries

Defines the property bag properties for the root folder of the list

Declaration

public PropertyBagEntryCollection PropertyBagEntries { get; }

Property Value

PropertyBagEntryCollection

ReadSecurity

Defines the Read Security property, optional attribute.

Declaration

public int ReadSecurity { get; set; }

Property Value

System.Int32

RemoveExistingContentTypes

Gets or sets whether existing content types should be removed

Declaration

public bool RemoveExistingContentTypes { get; set; }

Property Value

System.Boolean

RemoveExistingViews

Gets or sets whether existing views should be removed

Declaration

public bool RemoveExistingViews { get; set; }

Property Value

System.Boolean

Security

Defines the Security rules for the List Instance

Declaration

public ObjectSecurity Security { get; set; }

Property Value

ObjectSecurity

TemplateFeatureID

Gets or sets the Guid for TemplateFeature

Declaration

public Guid TemplateFeatureID { get; set; }

Property Value

Guid

TemplateInternalName

Defines the alternate template internal name for a list based on a .STP file/list definition

Declaration

public String TemplateInternalName { get; set; }

Property Value

String

TemplateType

Gets or sets a value that specifies the list server template of the new list. https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.listtemplatetype.aspx

Declaration

public int TemplateType { get; set; }

Property Value

System.Int32

Title

Gets or sets the list title

Declaration

public string Title { get; set; }

Property Value

System.String

Url

Gets or sets a value that specifies whether the new list is displayed on the Quick Launch of the site.

Declaration

public string Url { get; set; }

Property Value

System.String

UserCustomActions

Defines a collection of user custom actions that will be provisioned into the target list/library

Declaration

public CustomActionCollection UserCustomActions { get; }

Property Value

CustomActionCollection

ValidationFormula

Defines a value that specifies the data validation criteria for a list item, optional attribute.

Declaration

public String ValidationFormula { get; set; }

Property Value

String

ValidationMessage

Defines a value that specifies the error message returned when data validation fails for a list item, optional attribute.

Declaration

public String ValidationMessage { get; set; }

Property Value

String

Views

Gets or sets the views associated to the list

Declaration

public ViewCollection Views { get; }

Property Value

ViewCollection

Webhooks

Declaration

public WebhookCollection Webhooks { get; }

Property Value

WebhookCollection

WriteSecurity

Defines the Write Security property, optional attribute.

Declaration

public int WriteSecurity { get; set; }

Property Value

System.Int32

Methods

Equals(ListInstance)

Compares ListInstance object based on ContentTypesEnabled, Description, DocumentTemplate, EnableVersioning, EnableMinorVersions, EnableModeration, Hidden, MaxVersionLimit, MinorVersionLimit, OnQuickLaunch, EnableAttachments, EnableFolderCreation, ForceCheckOut, RemoveExistingContentTypes, TemplateType, Title, Url, TemplateFeatureID, RemoveExistingViews, ContentTypeBindings, View, Fields, FieldRefs, FieldDefaults, Security, Folders, UserCustomActions, Webhooks, IRMSettings, DefaultDisplayFormUrl, DefaultEditFormUrl, DefaultNewFormUrl, Direction, ImageUrl, IrmExpire, IrmReject, IsApplicationList, ReadSecurity, ValidationFormula, ValidationMessage, DataSource, WriteSecurity, TemplateInternalName, and DefaultColumnValues properties.

Declaration

public bool Equals(ListInstance other)

Parameters

ListInstance other ListInstance object

Returns

System.Boolean true if the ListInstance object is equal to the current object; otherwise, false.

Equals(Object)

Compares object with ListInstance

Declaration

public override bool Equals(object obj)

Parameters

System.Object obj Object that represents ListInstance

Returns

System.Boolean true if the current object is equal to the ListInstance

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

System.Int32 Returns HashCode

Extension Methods

ValidationExtensions.ValidateNotNullOrEmpty<T>(T, String)

ObjectExtensions.Set<TObject, T>(TObject, Expression<Func<TObject, T>>, T, Boolean, Boolean)

ObjectExtensions.GetPublicInstancePropertyValue(Object, String)

ObjectExtensions.GetPublicInstanceProperty(Object, String)

ObjectExtensions.SetPublicInstancePropertyValue(Object, String, Object)

Extensions.ToByteArray(Object)