SPList SPList SPList Class

Definition

public ref class SPList : Microsoft::SharePoint::SPSecurableObject
[Microsoft.SharePoint.Client.ClientCallableType(DeleteMethodClientName="DeleteObject", EntityKeyPropertyNames="ID", ETagPropertyName="Version", FactoryType=typeof(Microsoft.SharePoint.SPObjectFactory), Name="List", ObjectIdentityPropertyName="CanonicalId", ObjectUrlPathPropertyName="Microsoft.SharePoint.SPObjectUrlPath.GetUrlPath", ObjectVersionPropertyName="Version", PatchUpdateMethodClientName="Update", PutUpdateMethodClientName="Update", SampleUrl="{apiroot}/web/lists({listid})", ServerTypeId="{D89F0B18-614E-4b4a-BAC0-FD6142B55448}")]
[Microsoft.SharePoint.Client.SubsetCallableType(ForcePolymorphicForReturnTypes=true)]
public class SPList : Microsoft.SharePoint.SPSecurableObject
Public Class SPList
Inherits SPSecurableObject
Inheritance
Derived
Attributes
Microsoft.SharePoint.Client.ClientCallableTypeAttribute Microsoft.SharePoint.Client.SubsetCallableTypeAttribute

Fields

m_arrListProps m_arrListProps m_arrListProps
m_iRow m_iRow m_iRow
m_ListAttributesDict m_ListAttributesDict m_ListAttributesDict
m_Lists m_Lists m_Lists
m_Permissions m_Permissions m_Permissions

Properties

AlertTemplate AlertTemplate AlertTemplate
AllowContentTypes AllowContentTypes AllowContentTypes
AllowDeletion AllowDeletion AllowDeletion
AllowEveryoneViewItems AllowEveryoneViewItems AllowEveryoneViewItems
AllowMultiResponses AllowMultiResponses AllowMultiResponses
AllowRssFeeds AllowRssFeeds AllowRssFeeds
AllRolesForCurrentUser AllRolesForCurrentUser AllRolesForCurrentUser Inherited from SPSecurableObject
AnonymousPermMask AnonymousPermMask AnonymousPermMask
AnonymousPermMask64 AnonymousPermMask64 AnonymousPermMask64
Audit Audit Audit
Author Author Author
BaseTemplate BaseTemplate BaseTemplate
BaseType BaseType BaseType
BrowserFileHandling BrowserFileHandling BrowserFileHandling
CalculationOptions CalculationOptions CalculationOptions
CanReceiveEmail CanReceiveEmail CanReceiveEmail
ClientFormListData ClientFormListData ClientFormListData
ContentTypes ContentTypes ContentTypes
ContentTypesEnabled ContentTypesEnabled ContentTypesEnabled
Created Created Created
CurrentChangeToken CurrentChangeToken CurrentChangeToken
DataSource DataSource DataSource
DefaultApprovalWorkflowId DefaultApprovalWorkflowId DefaultApprovalWorkflowId
DefaultContentApprovalWorkflowId DefaultContentApprovalWorkflowId DefaultContentApprovalWorkflowId
DefaultDisplayFormUrl DefaultDisplayFormUrl DefaultDisplayFormUrl
DefaultEditFormUrl DefaultEditFormUrl DefaultEditFormUrl
DefaultItemOpen DefaultItemOpen DefaultItemOpen
DefaultItemOpenUseListSetting DefaultItemOpenUseListSetting DefaultItemOpenUseListSetting
DefaultNewFormUrl DefaultNewFormUrl DefaultNewFormUrl
DefaultView DefaultView DefaultView
DefaultViewUrl DefaultViewUrl DefaultViewUrl
Description Description Description
DescriptionResource DescriptionResource DescriptionResource
Direction Direction Direction
DisableGridEditing DisableGridEditing DisableGridEditing
DraftVersionVisibility DraftVersionVisibility DraftVersionVisibility
EffectiveBasePermissions EffectiveBasePermissions EffectiveBasePermissions
EffectiveBasePermissionsForUI EffectiveBasePermissionsForUI EffectiveBasePermissionsForUI
EffectiveFolderPermissions EffectiveFolderPermissions EffectiveFolderPermissions
EffectiveFolderPermissionsForUI EffectiveFolderPermissionsForUI EffectiveFolderPermissionsForUI
EmailAlias EmailAlias EmailAlias
EnableAssignToEmail EnableAssignToEmail EnableAssignToEmail
EnableAttachments EnableAttachments EnableAttachments
EnableDeployingList EnableDeployingList EnableDeployingList
EnableDeployWithDependentList EnableDeployWithDependentList EnableDeployWithDependentList
EnableFolderCreation EnableFolderCreation EnableFolderCreation
EnableMinorVersions EnableMinorVersions EnableMinorVersions
EnableModeration EnableModeration EnableModeration
EnablePeopleSelector EnablePeopleSelector EnablePeopleSelector
EnableResourceSelector EnableResourceSelector EnableResourceSelector
EnableSchemaCaching EnableSchemaCaching EnableSchemaCaching
EnableSyndication EnableSyndication EnableSyndication
EnableThrottling EnableThrottling EnableThrottling
EnableVersioning EnableVersioning EnableVersioning
EnforceDataValidation EnforceDataValidation EnforceDataValidation
EntityTypeName EntityTypeName EntityTypeName
EventReceivers EventReceivers EventReceivers
EventSinkAssembly EventSinkAssembly EventSinkAssembly
EventSinkClass EventSinkClass EventSinkClass
EventSinkData EventSinkData EventSinkData
ExcludeFromOfflineClient ExcludeFromOfflineClient ExcludeFromOfflineClient
ExcludeFromTemplate ExcludeFromTemplate ExcludeFromTemplate
FetchPropertyBagForListView FetchPropertyBagForListView FetchPropertyBagForListView
FieldIndexes FieldIndexes FieldIndexes
Fields Fields Fields
FirstUniqueAncestor FirstUniqueAncestor FirstUniqueAncestor Inherited from SPSecurableObject
FirstUniqueAncestorSecurableObject FirstUniqueAncestorSecurableObject FirstUniqueAncestorSecurableObject
Folders Folders Folders
Followable Followable Followable
ForceCheckout ForceCheckout ForceCheckout
ForceDefaultContentType ForceDefaultContentType ForceDefaultContentType
Forms Forms Forms
HasExternalDataSource HasExternalDataSource HasExternalDataSource
HasUniqueRoleAssignments HasUniqueRoleAssignments HasUniqueRoleAssignments Inherited from SPSecurableObject
Hidden Hidden Hidden
ID ID ID
ImageUrl ImageUrl ImageUrl
IndexedRootFolderPropertyKeys IndexedRootFolderPropertyKeys IndexedRootFolderPropertyKeys
InformationRightsManagementSettings InformationRightsManagementSettings InformationRightsManagementSettings
IrmEnabled IrmEnabled IrmEnabled
IrmExpire IrmExpire IrmExpire
IrmReject IrmReject IrmReject
IsApplicationList IsApplicationList IsApplicationList
IsPrivate IsPrivate IsPrivate
IsSiteAssetsLibrary IsSiteAssetsLibrary IsSiteAssetsLibrary
IsThrottled IsThrottled IsThrottled
ItemCount ItemCount ItemCount
Items Items Items
LastItemDeletedDate LastItemDeletedDate LastItemDeletedDate
LastItemModifiedDate LastItemModifiedDate LastItemModifiedDate
ListItemEntityTypeFullName ListItemEntityTypeFullName ListItemEntityTypeFullName
Lists Lists Lists
ListViewWebPartKey ListViewWebPartKey ListViewWebPartKey
MajorVersionLimit MajorVersionLimit MajorVersionLimit
MajorWithMinorVersionsLimit MajorWithMinorVersionsLimit MajorWithMinorVersionsLimit
MobileDefaultDisplayFormUrl MobileDefaultDisplayFormUrl MobileDefaultDisplayFormUrl
MobileDefaultEditFormUrl MobileDefaultEditFormUrl MobileDefaultEditFormUrl
MobileDefaultNewFormUrl MobileDefaultNewFormUrl MobileDefaultNewFormUrl
MobileDefaultView MobileDefaultView MobileDefaultView
MobileDefaultViewUrl MobileDefaultViewUrl MobileDefaultViewUrl
MultipleDataList MultipleDataList MultipleDataList
NavigateForFormsPages NavigateForFormsPages NavigateForFormsPages
NeedUpdateSiteClientTag NeedUpdateSiteClientTag NeedUpdateSiteClientTag
NoCrawl NoCrawl NoCrawl
OnQuickLaunch OnQuickLaunch OnQuickLaunch
Ordered Ordered Ordered
ParentWeb ParentWeb ParentWeb
ParentWebUrl ParentWebUrl ParentWebUrl
Permissions Permissions Permissions
PropertiesXml PropertiesXml PropertiesXml
ReadOnlyUI ReadOnlyUI ReadOnlyUI
ReadSecurity ReadSecurity ReadSecurity
RequestAccessEnabled RequestAccessEnabled RequestAccessEnabled
RestrictedTemplateList RestrictedTemplateList RestrictedTemplateList
RestrictUserUpdates RestrictUserUpdates RestrictUserUpdates
ReusableAcl ReusableAcl ReusableAcl
RoleAssignments RoleAssignments RoleAssignments Inherited from SPSecurableObject
RootFolder RootFolder RootFolder
RootWebOnly RootWebOnly RootWebOnly
SchemaXml SchemaXml SchemaXml
SchemaXmlInCurrentUICulture SchemaXmlInCurrentUICulture SchemaXmlInCurrentUICulture
SendToLocationName SendToLocationName SendToLocationName
SendToLocationUrl SendToLocationUrl SendToLocationUrl
ServerTemplateCanCreateFolders ServerTemplateCanCreateFolders ServerTemplateCanCreateFolders
ShowUser ShowUser ShowUser
SmsAlertTemplate SmsAlertTemplate SmsAlertTemplate
TemplateFeatureId TemplateFeatureId TemplateFeatureId
Title Title Title
TitleResource TitleResource TitleResource
UseFormsForDisplay UseFormsForDisplay UseFormsForDisplay
UserCustomActions UserCustomActions UserCustomActions
UserResources UserResources UserResources
ValidationFormula ValidationFormula ValidationFormula
ValidationMessage ValidationMessage ValidationMessage
Version Version Version
Views Views Views
WorkflowAssociations WorkflowAssociations WorkflowAssociations
WriteSecurity WriteSecurity WriteSecurity

Methods

AddItem() AddItem() AddItem()
AddItem(String, SPFileSystemObjectType) AddItem(String, SPFileSystemObjectType) AddItem(String, SPFileSystemObjectType)
AddItem(String, SPFileSystemObjectType, String) AddItem(String, SPFileSystemObjectType, String) AddItem(String, SPFileSystemObjectType, String)
AddWorkflowAssociation(SPWorkflowAssociation) AddWorkflowAssociation(SPWorkflowAssociation) AddWorkflowAssociation(SPWorkflowAssociation)
AppendDataTable(SPQuery, SPListGetDataTableOptions, DataTable, SPListItemCollectionPosition) AppendDataTable(SPQuery, SPListGetDataTableOptions, DataTable, SPListItemCollectionPosition) AppendDataTable(SPQuery, SPListGetDataTableOptions, DataTable, SPListItemCollectionPosition)
BreakRoleInheritance(Boolean) BreakRoleInheritance(Boolean) BreakRoleInheritance(Boolean) Inherited from SPSecurableObject
BreakRoleInheritance(Boolean, Boolean) BreakRoleInheritance(Boolean, Boolean) BreakRoleInheritance(Boolean, Boolean)
CheckPermissions(SPBasePermissions) CheckPermissions(SPBasePermissions) CheckPermissions(SPBasePermissions)
Delete() Delete() Delete()
DoesUserHavePermissions(SPBasePermissions) DoesUserHavePermissions(SPBasePermissions) DoesUserHavePermissions(SPBasePermissions) Inherited from SPSecurableObject
DoesUserHavePermissions(SPBasePermissions, Boolean) DoesUserHavePermissions(SPBasePermissions, Boolean) DoesUserHavePermissions(SPBasePermissions, Boolean)
DoesUserHavePermissions(SPUser, SPBasePermissions) DoesUserHavePermissions(SPUser, SPBasePermissions) DoesUserHavePermissions(SPUser, SPBasePermissions)
DoesUserHavePermissionsForUI(SPBasePermissions) DoesUserHavePermissionsForUI(SPBasePermissions) DoesUserHavePermissionsForUI(SPBasePermissions)
DoesUserHavePermissionsForUI(SPBasePermissions, Boolean) DoesUserHavePermissionsForUI(SPBasePermissions, Boolean) DoesUserHavePermissionsForUI(SPBasePermissions, Boolean)
EnsurePropsFresh() EnsurePropsFresh() EnsurePropsFresh()
EnsureRssSettings() EnsureRssSettings() EnsureRssSettings()
GetChanges() GetChanges() GetChanges()
GetChanges(SPChangeQuery) GetChanges(SPChangeQuery) GetChanges(SPChangeQuery)
GetChanges(SPChangeToken) GetChanges(SPChangeToken) GetChanges(SPChangeToken)
GetChanges(SPChangeToken, SPChangeToken) GetChanges(SPChangeToken, SPChangeToken) GetChanges(SPChangeToken, SPChangeToken)
GetContentTypeIdByUrl(String) GetContentTypeIdByUrl(String) GetContentTypeIdByUrl(String)
GetDataTable(SPQuery, SPListGetDataTableOptions, SPListItemCollectionPosition) GetDataTable(SPQuery, SPListGetDataTableOptions, SPListItemCollectionPosition) GetDataTable(SPQuery, SPListGetDataTableOptions, SPListItemCollectionPosition)
GetDefaultViewForContentType(SPContentTypeId) GetDefaultViewForContentType(SPContentTypeId) GetDefaultViewForContentType(SPContentTypeId)
GetDirectChildContentType(SPContentTypeId) GetDirectChildContentType(SPContentTypeId) GetDirectChildContentType(SPContentTypeId)
GetDistinctFieldValues(SPField, Object[,]) GetDistinctFieldValues(SPField, Object[,]) GetDistinctFieldValues(SPField, Object[,])
GetItemById(Int32) GetItemById(Int32) GetItemById(Int32)
GetItemByIdAllFields(Int32) GetItemByIdAllFields(Int32) GetItemByIdAllFields(Int32)
GetItemByIdSelectedFields(Int32, String[]) GetItemByIdSelectedFields(Int32, String[]) GetItemByIdSelectedFields(Int32, String[])
GetItemByUniqueId(Guid) GetItemByUniqueId(Guid) GetItemByUniqueId(Guid)
GetItems(SPQuery) GetItems(SPQuery) GetItems(SPQuery)
GetItems(SPQuery, String) GetItems(SPQuery, String) GetItems(SPQuery, String)
GetItems(SPView) GetItems(SPView) GetItems(SPView)
GetItems(String[]) GetItems(String[]) GetItems(String[])
GetItemsWithUniquePermissions() GetItemsWithUniquePermissions() GetItemsWithUniquePermissions()
GetItemsWithUniquePermissions(Int32, Boolean) GetItemsWithUniquePermissions(Int32, Boolean) GetItemsWithUniquePermissions(Int32, Boolean)
GetPropertiesXmlForUncustomizedViews() GetPropertiesXmlForUncustomizedViews() GetPropertiesXmlForUncustomizedViews()
GetRelatedFields() GetRelatedFields() GetRelatedFields()
GetRelatedFields(SPRelationshipDeleteBehavior) GetRelatedFields(SPRelationshipDeleteBehavior) GetRelatedFields(SPRelationshipDeleteBehavior)
GetUncustomizedViewByBaseViewId(Int32) GetUncustomizedViewByBaseViewId(Int32) GetUncustomizedViewByBaseViewId(Int32)
GetUserEffectivePermissionInfo(String) GetUserEffectivePermissionInfo(String) GetUserEffectivePermissionInfo(String)
GetUserEffectivePermissions(String) GetUserEffectivePermissions(String) GetUserEffectivePermissions(String)
GetView(Guid) GetView(Guid) GetView(Guid)
IsContentTypeAllowed(SPContentType) IsContentTypeAllowed(SPContentType) IsContentTypeAllowed(SPContentType)
IsContentTypeAllowed(SPContentTypeId) IsContentTypeAllowed(SPContentTypeId) IsContentTypeAllowed(SPContentTypeId)
Recycle() Recycle() Recycle()
RemoveWorkflowAssociation(SPWorkflowAssociation) RemoveWorkflowAssociation(SPWorkflowAssociation) RemoveWorkflowAssociation(SPWorkflowAssociation)
RenderAsHtml(SPQuery) RenderAsHtml(SPQuery) RenderAsHtml(SPQuery)
RenderListData(String) RenderListData(String) RenderListData(String)
RenderListData(String, Guid) RenderListData(String, Guid) RenderListData(String, Guid)
RenderListFormData(Int32, String, Int32) RenderListFormData(Int32, String, Int32) RenderListFormData(Int32, String, Int32)
ResetRoleInheritance() ResetRoleInheritance() ResetRoleInheritance()
SaveAsNewView(String, String, Boolean, Uri) SaveAsNewView(String, String, Boolean, Uri) SaveAsNewView(String, String, Boolean, Uri)
SaveAsTemplate(String, String, String, Boolean) SaveAsTemplate(String, String, String, Boolean) SaveAsTemplate(String, String, String, Boolean)
ServerTemplateCanReceiveEmail(SPListTemplateType, SPWeb) ServerTemplateCanReceiveEmail(SPListTemplateType, SPWeb) ServerTemplateCanReceiveEmail(SPListTemplateType, SPWeb)
SetAttributesForPropertiesXML(XmlTextWriter) SetAttributesForPropertiesXML(XmlTextWriter) SetAttributesForPropertiesXML(XmlTextWriter)
ToString() ToString() ToString()
Update() Update() Update()
Update(Boolean) Update(Boolean) Update(Boolean)
UpdateWorkflowAssociation(SPWorkflowAssociation) UpdateWorkflowAssociation(SPWorkflowAssociation) UpdateWorkflowAssociation(SPWorkflowAssociation)
WriteRssFeed(Stream) WriteRssFeed(Stream) WriteRssFeed(Stream)
WriteRssFeed(Stream, Int32) WriteRssFeed(Stream, Int32) WriteRssFeed(Stream, Int32)
WriteRssFeed(Stream, Int32, SPView) WriteRssFeed(Stream, Int32, SPView) WriteRssFeed(Stream, Int32, SPView)

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to