List element (DeploymentManifest)

2022-06-29

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Represents an instance of a Windows SharePoint Services 3.0 list (SPList) object.

Definition

DECLARATION
<xs:element name="List" type="SPList" />

USAGE
<SPObject
        <List
                Id="Guid"
                Title="xs:string"
                RootFolderId="Guid"
                RootFolderUrl="xs:string"
                ParentWebId="Guid"
                ParentWebUrl="xs:string"
                BaseType="SPBaseType"
                BaseTemplate="SPListTemplateType"
                TemplateFeatureId="Guid"
                Description="xs:string"
                Direction="xs:string"
                DocumentTemplateId="Guid"
                EventSinkAssembly="xs:string"
                SendToLocationName="xs:string"
                SendToLocationUrl="xs:string"
                EventSinkClass="xs:string"
                EventSinkData="xs:string"
                ImageUrl="xs:string"
                AllowDeletion="xs:boolean"
                AllowMultiResponses="xs:boolean"
                EnableAttachments="xs:boolean"
                EnableModeration="xs:boolean"
                EnableVersioning="xs:boolean"
                EnableMinorVersions="xs:boolean"
                RequestAccessEnabled="xs:boolean"
                DraftVersionVisibility="DraftVisibilityType"
                ForceCheckout="xs:boolean"
                ExcludeFromTemplate="xs:boolean"
                Hidden="xs:boolean"
                MultipleDataList="xs:boolean"
                Ordered="xs:boolean"
                ShowUser="xs:boolean"
                Author="xs:string"
                Created="xs:dateTime"
                OnQuickLaunch="xs:boolean"
                ReadSecurity="xs:int"
                WriteSecurity="xs:int"
                Version="xs:int"
                MajorVersionLimit="xs:int"
                MajorWithMinorVersionsLimit="xs:int"
                EmailAlias="xs:string"
                EnableContentTypes="xs:boolean"
                EnableDeployWithDependentList="xs:boolean"
                EnableFolderCreation="xs:boolean"
                DefaultItemOpen="DefaultItemOpen"
                DefaultContentApprovalWorkflowId="Guid"
                EnableAssignToEmail="xs:boolean"
                EnableSyndication="xs:boolean"
                   <Fields />
           <ContentTypes />
           <Views />
           <Forms />
           <EventReceivers />
           <DeleteFields />
        />
/>

Type

SPList

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Type	Description
AllowDeletion	xs:boolean	Optional. Specifies whether the list can be deleted.
AllowMultiResponses	xs:boolean	Optional. Specifies whether users are allowed to make multiple responses to a survey.
Author	xs:string	Optional. User who created the list.
BaseTemplate	SPListTemplateType Simple Type (DeploymentManifest)	Required. Specifies a base type for instantiating list templates. Includes, but is not limited to, types enumerated in SPListTemplateType.
BaseType	SPBaseType Simple Type (DeploymentManifest)	Optional. Specifies the base type for the list.
Created	xs:dateTime	Optional. Specifies the time and date the list was created.
DefaultContentApprovalWrokFlowId	Guid Simple Type (DeploymentManifest)	Optional. Unique identifier of the default content approval workflow that is associated with the list.
DefaultItemOpen	DefaultItemOpen Simple Type (DeploymentManifest)	Optional. Specifies whether to open list items in a client application or in the browser.
Description	xs:string	Optional. Provides a description for the list.
Direction	xs:string	Optional. Specifies the direction of the reading order for the list. The string value "ltr" specifies left-to-right; the string "rtl" specifies either right-to-left, or that no reading order is specified.
DocumentTemplateId	Guid Simple Type (DeploymentManifest)	Optional. Unique identifier of the document template.
DraftVersionVisibility	DraftVisibilityType Simple Type (DeploymentManifest)	Optional. Specifies user types that can view minor versions of document drafts within the list.
EmailAlias	xs:string	Optional. When email notification is enabled (EnableAssignToEmail=true), specifies the email address to use to notify the owner of an item when the item has been updated or the assignment has changed.
EnableAssignToEmail	xs:boolean	Optional. Specifies whether email notification is enabled for the list.
EnableAttachments	xs:boolean	Optional. Specifies whether attachments can be added to items in the list; true if attachments can be added, otherwise false.
EnableContentTypes	xs:boolean	Optional.
EnableDeployWithDependentList	xs:boolean	Optional. Specifies whether the list can be deployed with a dependent list; true if the list can be deployed with a dependent list, otherwise false.
EnableFolderCreation	xs:boolean	Optional. Specifies whether folders can be created in the list; true if folders can be created, otherwise false.
EnableMinorVersions	xs:boolean	Optional. When versioning is enabled for a document library (EnableVersioning=true), specifies whether the minor versions are enabled.
EnableModeration	xs:boolean	Optional. Specifies whether the Content Approval feature is enabled for the list; true if approval feature is enabled, otherwise false.
EnableSyndication	xs:boolean	Optional. Specifies whether RSS syndication is enabled for the list.
EnableVersioning	xs:boolean	Optional. Specifies whether versioning is enabled for the document library; true if versioning is enabled, otherwise false.
EventSinkAssembly	xs:string	Optional. Strong name of a file in the global assembly cache (GAC) that provides an event handler for document library events.
EventSinkClass	xs:string	Optional. Fully qualified, case-sensitive name of a class that defines an event handler for document library events.
EventSinkData	xs:string	Optional. Arbitrary string for use by an event handler for document library events.
ExcludeFromTemplate	xs:boolean	Optional. Specifies whether the content of the list is included when the list is saved as a list template or when the site to which the list belongs is saved as a site template. The value is true if the content is excluded, otherwise false.
ForceCheckout	xs:boolean	Optional. Specifies whether Forced Checkout is enabled for the document library; true if forced checkout is enabled, otherwise false.
Hidden	xs:boolean	Optional. Specifies whether the list is hidden; true if the list is hidden, otherwise false.
Id	Guid Simple Type (DeploymentManifest)	Required. Unique identifier of the list in the database.
ImageUrl	xs:string	Optional. The server-relative URL for the icon that represents the list.
MajorVersionLimit	xs:int	Optional. For document library that uses version control with major versions only, specifies the maximum number of major versions allowed for an item.
MajorWithMinorVersionsLimit	xs:int	Optional. For a document library that uses version control with both major and minor versions, specifies the number of major versions allowed for an item.
MultipleDataList	xs:boolean	Optional. Specifies whether the list in a Meeting Workspace site contains data for multiple meeting instances within the site.
OnQuickLaunch	xs:boolean	Optional. Specifies whether the list provides Quick Launch on the home page; true if Quick Launch is enabled, otherwise false.
Ordered	xs:boolean	Optional. Specifies whether the option to allow users to reorder items in the list is available on the Edit View page for the list; true if ordering is enabled, otherwise false.
ParentWebId	Guid Simple Type (DeploymentManifest)	Required. Unique identifier for the parent website for the list.
ParentWebUrl	xs:string	Optional. The URL of the parent website for the list.
ReadSecurity	xs:int	Optional. Specifies the Read security setting for the list.
RequestAccessEnabled	xs:boolean	Optional. Specifies whether the option to allow users to request access to the list is available; true if requesting access is enabled, otherwise false.
RootFolderId	Guid Simple Type (DeploymentManifest)	Optional. Unique identifier of the folder that contains all of the files used in working with the list.
RootFolderUrl	xs:string	Required. Server-relative URL to the folder that contains files used in working with the list.
SendToLocationName	xs:string	Optional. File name to use when copying an item in the list to another document library.
SendToLocationUrl	xs:string	Optional. URL to use when copying an item in the list to another document library.
ShowUser	xs:boolean	Optional. Specifies whether user names are shown in the results of a survey; true if user names are shown, otherwise false.
TemplateFeatureId	Guid Simple Type (DeploymentManifest)	Optional. Unique identifier of a template feature that is associated with the list.
Title	xs:string	Required. Display title for the list.
Version	xs:int	Optional. Version number of the list.
WriteSecurity	xs:int	Optional. Specifies the Write security setting for the list.

Child elements

Parent elements

SPObject Element (DeploymentManifest)

Share via