2.2.4.11 ListDefinitionCT

SharePoint

The ListDefinitionCT complex type specifies information about a particular list.

 <s:complexType name="ListDefinitionCT">
   <s:attribute name="DocTemplateUrl" type="s:string" />
   <s:attribute name="DefaultViewUrl" type="s:string" use="required" />
   <s:attribute name="MobileDefaultViewUrl" type="s:string" />
   <s:attribute name="ID" type="s:string" use="required" />
   <s:attribute name="Title" type="s:string" use="required" />
   <s:attribute name="Description" type="s:string" />
   <s:attribute name="ImageUrl" type="s:string" use="required" />
   <s:attribute name="Name" type="s:string" use="required" />
   <s:attribute name="BaseType" type="s:string" use="required" />
   <s:attribute name="FeatureId" type="s:string" use="required" />
   <s:attribute name="ServerTemplate" type="s:string" use="required" />
   <s:attribute name="Created" type="s:string" use="required" />
   <s:attribute name="Modified" type="s:string" use="required" />
   <s:attribute name="LastDeleted" type="s:string" />
   <s:attribute name="Version" type="s:int" use="required" />
   <s:attribute name="Direction" type="s:string" use="required" />
   <s:attribute name="ThumbnailSize" type="s:string" />
   <s:attribute name="WebImageWidth" type="s:string" />
   <s:attribute name="WebImageHeight" type="s:string" />
   <s:attribute name="Flags" type="s:int" />
   <s:attribute name="ItemCount" type="s:int" use="required" />
   <s:attribute name="AnonymousPermMask" type="unsignedLong" />
   <s:attribute name="RootFolder" type="s:string" />
   <s:attribute name="ReadSecurity" type="s:int" use="required" />
   <s:attribute name="WriteSecurity" type="s:int" use="required" />
   <s:attribute name="Author" type="s:string" />
   <s:attribute name="EventSinkAssembly" type="s:string" />
   <s:attribute name="EventSinkClass" type="s:string" />
   <s:attribute name="EventSinkData" type="s:string" />
   <s:attribute name="EmailInsertsFolder" type="s:string" />
   <s:attribute name="EmailAlias" type="s:string" />
   <s:attribute name="WebFullUrl" type="s:string" />
   <s:attribute name="WebId" type="s:string" />
   <s:attribute name="SendToLocation" type="s:string" />
   <s:attribute name="ScopeId" type="s:string" />
   <s:attribute name="MajorVersionLimit" type="s:int" />
   <s:attribute name="MajorWithMinorVersionsLimit" type="s:int" />
   <s:attribute name="WorkFlowId" type="s:string" />
   <s:attribute name="HasUniqueScopes" type="core:TRUEFALSE" />
   <s:attribute name="NoThrottleListOperations" type="core:TRUEFALSE" />
   <s:attribute name="HasRelatedLists" type="s:string" />
   <s:attribute name="AllowDeletion" type="core:TRUEFALSE" />
   <s:attribute name="AllowMultiResponses" type="core:TRUEFALSE" />
   <s:attribute name="EnableAttachments" type="core:TRUEFALSE" />
   <s:attribute name="EnableModeration" type="core:TRUEFALSE" />
   <s:attribute name="EnableVersioning" type="core:TRUEFALSE" />
   <s:attribute name="HasExternalDataSource" type="core:TRUEFALSE" />
   <s:attribute name="Hidden" type="core:TRUEFALSE" />
   <s:attribute name="MultipleDataList" type="core:TRUEFALSE" />
   <s:attribute name="Ordered" type="core:TRUEFALSE" />
   <s:attribute name="ShowUser" type="core:TRUEFALSE" />
   <s:attribute name="EnablePeopleSelector" type="core:TRUEFALSE" />
   <s:attribute name="EnableResourceSelector" type="core:TRUEFALSE" />
   <s:attribute name="EnableMinorVersion" type="core:TRUEFALSE" />
   <s:attribute name="RequireCheckout" type="core:TRUEFALSE" />
   <s:attribute name="ThrottleListOperations" type="core:TRUEFALSE" />
   <s:attribute name="ExcludeFromOfflineClient" type="core:TRUEFALSE" />
   <s:attribute name="CanOpenFileAsync" type="core:TRUEFALSE" />
   <s:attribute name="EnableFolderCreation" type="core:TRUEFALSE" />
   <s:attribute name="IrmEnabled" type="core:TRUEFALSE" />
   <s:attribute name="IsApplicationList" type="core:TRUEFALSE" />
   <s:attribute name="PreserveEmptyValues" type="core:TRUEFALSE" />
   <s:attribute name="StrictTypeCoercion" type="core:TRUEFALSE" />
   <s:attribute name="EnforceDataValidation" type="core:TRUEFALSE" use="optional"/>
   <s:attribute name="MaxItemsPerThrottledOperation" type="s:int" />
   <s:attribute name="EnableAssignedToEmail" type="core:TRUEFALSE" use="optional"/>
   <s:attribute name="Followable" type="core:TRUEFALSE" />
   <s:attribute name="Acl" type="s:string" use="optional"/>
   <s:attribute name="Flags2" type="s:int" use="optional"/>
   <s:attribute name="RootFolderId" type="s:string" use="optional"/>
   <s:attribute name="IrmSyncable" type="core:TRUEFALSE" use="optional"/>/>
 </s:complexType> 

ListDefinitionCT.DocTemplateUrl: This is the server-relative URL to the location of the template document used for creating new items in a document library. This SHOULD only be used by document libraries.

ListDefinitionCT.DefaultViewUrl: The server-relative path to the page containing the default mobile list view.

ListDefinitionCT.MobileDefaultViewUrl: The server-relative path to the page containing the default mobile list view.

ListDefinitionCT.ID: The GUID for the list.

ListDefinitionCT.Title: The display name of the list.

ListDefinitionCT.Description: The description of the list.

ListDefinitionCT.ImageUrl: The server-relative path to the image that is used to represent this list.

ListDefinitionCT.Name: The internal name for the list. The Name is equal to ID.

ListDefinitionCT.BaseType: The base type of the list. See [MS-WSSFO2] section 2.2.3.11 for the possible values of the BaseType.

ListDefinitionCT.FeatureID: The GUID of the feature that contains the list schema for the list. It MUST be an empty GUID, if the list schema is not contained within a feature.

ListDefinitionCT.ServerTemplate: The value corresponding to the template that the list is based on. See [MS-WSSFO3] section 2.2.1.2.12 for the possible values.

ListDefinitionCT.Created: Specifies the UTC date and time in the Gregorian calendar when the list was created, in the format "yyyyMMdd hh:mm:ss": where "yyyy" represents the year, "MM" represents the month, "dd" represents the day of the month, "hh" represents the hour, "mm" represents the minute, and "ss" represents the second.

ListDefinitionCT.Modified: Specifies the UTC date and time in the Gregorian calendar when the list was last modified in the format "yyyyMMdd hh:mm:ss": where "yyyy" represents the year, "MM" represents the month, "dd" represents the day of the month, "hh" represents the hour, "mm" represents the minute, and "ss" represents the second.

ListDefinitionCT.LastDeleted: Specifies the UTC date and time in the Gregorian calendar when the list last had an element deleted in the format "yyyyMMdd hh:mm:ss": where "yyyy" represents the year, "MM" represents the month, "dd" represents the day of the month, "hh" represents the hour, "mm" represents the minute, and "ss" represents the second.

ListDefinitionCT.Version: The numeric major revision of the list.

ListDefinitionCT.Direction: Specifies the direction that items in the list are laid out in when displayed. This element MUST be one of the following values.

Value

Meaning

none

No direction is specified.

ltr

Items SHOULD be laid out from left to right.

rtl

Items SHOULD be laid out from right to left.

ListDefinitionCT.ThumbnailSize: The size of the thumbnail image in pixels. Used by picture libraries.

ListDefinitionCT.WebImageWidth: The display width of an image in pixels. Used by picture libraries.

ListDefinitionCT.WebImageHeight: The display height of an image in pixels. Used by picture libraries.

ListDefinitionCT.Flags: Bit Flags for the list. See [MS-WSSFO2] section 2.2.2.5 for more details about Flags.

ListDefinitionCT.ItemCount: The number of items in the list.

ListDefinitionCT.AnonymousPermMask: Bit Flags for the list describing the permissions given to anonymous users. See [MS-WSSFO2] section 2.2.2.14 for details about permissions.

ListDefinitionCT.RootFolder: The root folder of the list.

ListDefinitionCT.ReadSecurity: The read permission setting for this list MUST be one of the following values.

Value

Description

1

All users have read permission to all list items.

2

Users have read permission only to list items they create.

ListDefinitionCT.WriteSecurity: The write permission setting for this list MUST be one of the following values.

Value

Description

1

All users can modify all list items.

2

Users can only modify list items they create.

4

Users cannot modify any list items.

ListDefinitionCT.Author: The user identifier of the user who created the list, which is contained in the user information list.

ListDefinitionCT.EventSinkAssembly: The assembly name of a file in the global assembly cache (GAC) that provides an event handler for document library events. Protocol clients MUST NOT use this attribute.<1>

ListDefinitionCT.EventSinkClass: The fully qualified, case-sensitive name of a class that defines an event handler for document library events. Protocol clients MUST NOT use this attribute.<2>

ListDefinitionCT.EventSinkData: An arbitrary string for use by an event handler for document library events. Protocol clients MUST NOT use this attribute.<3>

ListDefinitionCT.EmailInsertsFolder: The folder in a document library where documents uploaded by e-mail are inserted.

ListDefinitionCT.EmailAlias: The e-mail address used by a document library to receive incoming documents to be uploaded.

ListDefinitionCT.WebFullUrl: The server-relative path to the subsite that contains this list.

ListDefinitionCT.WebId: The GUID of the site that this list is associated with.

ListDefinitionCT.SendToLocation: The name and URL of a custom location to send list items from within a document library. These two items are returned as a string with a '|' character in between them.

ListDefinitionCT.ScopeId: The GUID of the site that contains this list, unless this list has been given unique permissions. In that case, this is the GUID of those permissions.

ListDefinitionCT.MajorVersionLimit: The maximum number of major versions allowed for a document in a document library that uses version control with only major versions.

ListDefinitionCT.MajorWithMinorVersionsLimit: The maximum number of major versions that are allowed for a document in a document library that uses version control with both major versions and minor versions.

ListDefinitionCT.WorkFlowId: The GUID of a workflow association that is used to manage the content approval process for the list. Only available for document libraries that have content management enabled and an associated content approval workflow.

ListDefinitionCT.HasUniqueScopes: True, if any list item within the list has a security scope different from the list itself.

ListDefinitionCT.NoThrottleListOperations: True, if the list is excluded from the query size threshold.

ListDefinitionCT.HasRelatedLists: "True", if this list has any related lists. Otherwise is "False". When it is returned by GetListCollection (section 3.1.4.17) this value will be an empty string.

ListDefinitionCT.AllowDeletion: True, if this list can be deleted.

ListDefinitionCT.AllowMultiResponses: True, if this list is a survey list and users are allowed to respond to it multiple times.

ListDefinitionCT.EnableAttachments: True, if attachments can be attached to items in this List.

ListDefinitionCT.EnableModeration: True, if content approval is enabled for this list.

ListDefinitionCT.EnableVersioning: True, if this list is a document library and version control is enabled.

ListDefinitionCT.HasExternalDataSource: True, if this list has an external data source.<4>

ListDefinitionCT.Hidden: True, if this list is hidden.

ListDefinitionCT.MultipleDataList: True, if the list is in a meeting workspace site, and it contains data for multiple meeting instances within the site.

ListDefinitionCT.Ordered: True, if list items can be explicitly re-ordered.

ListDefinitionCT.ShowUser: True, if this list is a survey list and user names are included in responses.

ListDefinitionCT.EnablePeopleSelector: True, if a UI for adding users is available on the list.<5>

ListDefinitionCT.EnableResourceSelector: True, if a UI for adding resources is available on the list.<6>

ListDefinitionCT.EnableMinorVersion: True, if this list is a document library and minor versions are enabled.

ListDefinitionCT.RequireCheckout: True, if this list is a document library and documents MUST be checked out before they can be modified.

ListDefinitionCT.ThrottleListOperations: False, if the list is excluded from the query size threshold.

ListDefinitionCT.ExcludeFromOfflineClient: True, if the content of the list is not recommended to be taken offline.<7>

ListDefinitionCT.CanOpenFileAsync: True, if the client attempts to open files asynchronously from the server. By default, it will return True to the client.<8>

ListDefinitionCT.EnableFolderCreation: True, if folder creation is enabled on the list.<9>

ListDefinitionCT.IrmEnabled: True, if Information Rights Management (IRM) is enabled on the list.<10>

ListDefinitionCT.IsApplicationList: True, if the list is an application list.<11>

ListDefinitionCT.PreserveEmptyValues: True, if Null values are preserved for expression evaluation. False, if there are no special requirements on how the protocol server treats Null values.<12>

ListDefinitionCT.StrictTypeCoercion: True, if expressions anywhere in the list that include invalid type casts, such as casting a date to a string, SHOULD return an error instead of attempting to perform the cast.<13>

ListDefinitionCT.MaxItemsPerThrottledOperation: Specifies the value of the query size threshold for the Web application.<14>

ListDefinitionCT.EnableAssignedToEmail: This attribute MUST be set to True, if the list is an issues list and the list is configured to send e-mail when an issue's "Assigned To" field value is changed. This attribute is only present if the current list is an issues list.

ListDefinitionCT.EnforceDataValidation: If True, the protocol server SHOULD enforce the field properties that limit the data values that can be stored in that field.<15> 

ListDefinitionCT.Followable: If True, the list can be followed in an activity feed.<16>

ListDefinitionCT.Acl: Specifies the access control list (ACL) information.<17>

ListDefinitionCT.Flags2: Additional Bit Flags for the list.<18> This element MUST be one of the following values.

Value

Description

0

Default value.

0x0000000000000001

The document parser is disabled on the list.

0x0000000000000002

The crawler indexes the non-default views of the list.

0x0000000000000004

The list has restricted item.

0x0000000000000008

The files in the list can be processed in asynchronous manner.

ListDefinitionCT.RootFolderId: The GUID of the root folder of the list.<19>

ListDefinitionCT.IrmSyncable: True, if Information Rights Management (IRM) can be synchronized on the list.<20>

Show: