SPList members

Represents a list on a Microsoft SharePoint Foundation Web site.

The SPList type exposes the following members.

Properties

	Name	Description
	AlertTemplate	Gets or sets the alert template that is used by the list.
	AllowContentTypes	Returns true if the list supports content types.
	AllowDeletion	Gets or sets a Boolean value specifying whether the list can be deleted.
	AllowEveryoneViewItems	Gets or sets a Boolean value specifying whether everyone can view documents in the document library or attachments to items in the list.
	AllowMultiResponses	Gets or sets a Boolean value specifying whether users are allowed to give multiple responses to the survey.
	AllowRssFeeds	Gets a Boolean value that specifies whether the list allows RSS feeds.
	AllRolesForCurrentUser	Gets a full list of role definitions on the object to which the current user belongs on this scope. (Inherited from SPSecurableObject.)
	AnonymousPermMask	Obsolete. Obsolete. Use the AnonymousPermMask64 property to get or set the base permissions for anonymous users of the list instead. (In Windows SharePoint Services 2.0, the AnonymousPermMask property got or set the permissions for anonymous users of the list.)
	AnonymousPermMask64	Gets or sets the base permissions for anonymous users of the list.
	Audit	Gets the audit log that is associated with the list.
	Author	Gets an SPUser object that represents information about the user who created the list.
	BaseTemplate	Gets the list definition type on which the list is based.
	BaseType	Gets the base type for the list.
	BrowserFileHandling	Indicates the list file handling mode.
	CalculationOptions	Indicates options for how calculated field formulas, list data validation formulas, and default value formulas are evaluated for the list.
	CanReceiveEmail	Gets a Boolean value specifying whether the list can receive e-mail.
	ClientFormListData	Returns a dictionary containing list properties used in CSR Forms
	ContentTypes	Gets the content types that are associated with the list.
	ContentTypesEnabled	Gets or sets a Boolean value specifying whether content types are enabled for the list.
	Created	Gets the creation date and time for the list.
	CurrentChangeToken	Gets the change token that will be used in logging the next change to the list.
	DataSource	Gets the data source for a list that has an external data source.
	DefaultApprovalWorkflowId	Obsolete. Use the DefaultContentApprovalWorkflowId property instead.
	DefaultContentApprovalWorkflowId	Gets or sets the globally unique identifier (GUID) of a workflow association that is used to manage the Content Approval process for the list.
	DefaultDisplayFormUrl	Gets or sets the URL to the default form for displaying list items.
	DefaultEditFormUrl	Gets or sets the URL to the default form for editing list items.
	DefaultItemOpen	Gets or sets a value that specifies whether to open list items in a client application or in the browser.
	DefaultItemOpenUseListSetting	This property indicates whether to use the List setting or the server-wide setting for DefaultItemOpen (BrowserEnabledDocuments setting) in the Web application.
	DefaultNewFormUrl	Gets or sets the URL to the default form for creating new list items.
	DefaultView	Gets the default view for the list.
	DefaultViewUrl	Gets the URL of the default view for the list.
	Description	Gets or sets the description for the list.
	DescriptionResource	Gets an SPUserResource object that represents the translations for the description of the list.
	Direction	Gets or sets the direction of the reading order for the list.
	DisableGridEditing	Property for assigning or retrieving grid editing on the list.
	DraftVersionVisibility	Gets or sets a value that determines the type of user who can view minor versions of document drafts within the list.
	EffectiveBasePermissions	Gets the effective base permissions of the current user for the list, including their group membership and policies. (Overrides SPSecurableObject.EffectiveBasePermissions.)
	EffectiveBasePermissionsForUI	Gets the effective base permissions for the current user, as they should be displayed in UI. This will only differ from EffectiveBasePermissions if ReadOnlyUI is set to true, and in all cases will be a subset of EffectiveBasePermissions. To put it another way, EffectiveBasePermissionsForUI will always be as or more restrictive than EffectiveBasePermissions.
	EffectiveFolderPermissions	Within an HTTP context, gets the effective base permissions for folders in the list.
	EffectiveFolderPermissionsForUI	get effective base permissions for UI for current user on the specified folder in a list. This will only differ from EffectiveFolderPermissions if ReadOnlyUI is set to true, and in all cases will be a subset of EffectiveFolderPermissions. To put it another way, EffectiveFolderPermissionsForUI will always be as or more restrictive than EffectiveFolderPermissions.
	EmailAlias	If e-mail notification is enabled, gets or sets the e-mail address to use to notify to the owner of an item when an assignment has changed or the item has been updated.
	EnableAssignToEmail	Gets or sets a Boolean value specifying whether e-mail notification is enabled for the list.
	EnableAttachments	Gets or sets a Boolean value that specifies whether attachments can be added to items in the list.
	EnableDeployingList	Obsolete. Gets or sets a Boolean value specifying whether the list can be deployed.
	EnableDeployWithDependentList	Gets or sets a Boolean value that specifies whether the list can be deployed with a dependent list.
	EnableFolderCreation	Gets or sets a Boolean value that specifies whether folders can be created for the list.
	EnableMinorVersions	Gets or sets a Boolean value that specifies whether minor versions are enabled when versioning is enabled for the document library.
	EnableModeration	Gets or sets a Boolean value that specifies whether Content Approval is enabled for the list.
	EnablePeopleSelector	Enable user selector on event list.
	EnableResourceSelector	Enables resource selector on an event list.
	EnableSchemaCaching	Gets or sets a Boolean value specifying whether schema caching is enabled for the list.
	EnableSyndication	Gets or sets a Boolean value that specifies whether RSS syndication is enabled for the list.
	EnableThrottling	Indicates whether throttling for this list is enabled or not.
	EnableVersioning	Gets or sets a Boolean value that specifies whether versioning is enabled for the document library.
	EnforceDataValidation	Gets or sets a value that indicates whether certain field properties are enforced when an item is added or updated.
	EntityTypeName	The entity type name.
	EventReceivers	Gets the collection of event receivers that have been registered for the list.
	EventSinkAssembly	Obsolete. Gets or sets the strong name of a file in the global assembly cache that provides a Windows SharePoint Services 2.0 event handler for document library events.
	EventSinkClass	Obsolete. Gets or sets the fully qualified, case-sensitive name of a class that defines a Windows SharePoint Services 2.0 event handler for document library events.
	EventSinkData	Obsolete. Gets or sets an arbitrary string for use by a Windows SharePoint Services 2.0 event handler for document library events.
	ExcludeFromOfflineClient	Gets or sets a value that indicates whether the list should be downloaded to the client during offline synchronization.
	ExcludeFromTemplate	Gets a Boolean value that indicates 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.
	FetchPropertyBagForListView	Specifies whether property bag information, as part of the list schema JSON, is retrieved when the list is being rendered on the client.
	FieldIndexes	Gets the collection of field indexes defined on the list.
	Fields	Gets the collection of field objects that represents all the fields in the list.
	FirstUniqueAncestor	Obsolete. Use the FirstUniqueAncestorSecurableObject property instead. (Inherited from SPSecurableObject.)
	FirstUniqueAncestorSecurableObject	Gets the object where role assignments for this list are defined. (Overrides SPSecurableObject.FirstUniqueAncestorSecurableObject.)
	Folders	Gets the collection of folder items for the list.
	Followable	Can a list be followed in an activity feed?
	ForceCheckout	Gets or sets a Boolean value that specifies whether forced checkout is enabled for the document library.
	ForceDefaultContentType	Specifies whether we want to return the default Document root content type.
	Forms	Gets a collection of form objects that represent the forms that are used in creating, editing, or displaying items in the list.
	HasExternalDataSource	Gets a value that indicates whether the list has an external data source.
	HasUniqueRoleAssignments	Indicates whether the object has unique role assignments or inherits its role assignments from a parent object. (Inherited from SPSecurableObject.)
	Hidden	Gets or sets a Boolean value that specifies whether the list is hidden.
	ID	Gets the GUID that identifies the list in the database.
	ImageUrl	Gets the server-relative URL for the icon that represents the list.
	IndexedRootFolderPropertyKeys	Gets the set of property keys for root folder properties that need to be exposed through Site Data Web Service.
	InformationRightsManagementSettings	settings of document library Information Rights Management (IRM)
	IrmEnabled	Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) is enabled for the list.
	IrmExpire	Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) expiration is enabled for the list.
	IrmReject	Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) rejection is enabled for the list.
	IsApplicationList	Indicates whether this list should be treated as a top level navigation object or not.
	IsPrivate	Gets a Boolean value that indicates whether the document library is a private list with restricted permissions, such as for Solutions.
	IsSiteAssetsLibrary	Indicates whether or not this list is designated as the default asset location for images or other files which the users uploads to their wiki pages.
	IsThrottled	Gets a value that indicates whether the total number of items exceeds the upper limit set for the list.
	ItemCount	Gets the number of items in the list, including folders.
	Items	Gets an unfiltered collection of all items in the list.
	LastItemDeletedDate	Gets the date and time that an item in the list was last deleted.
	LastItemModifiedDate	Gets the date and time that an item, field, or property of the list was last modified.
	ListItemEntityTypeFullName	The entity type full name of the list item in the list.
	Lists	Gets the parent collection of lists to which the list belongs.
	ListViewWebPartKey	This is the Web part key for the list view Web part.
	MajorVersionLimit	Gets or sets the maximum number of major versions allowed for an item in a document library that uses version control with major versions only.
	MajorWithMinorVersionsLimit	Gets or sets the maximum number of major versions that are allowed for an item in a document library that uses version control with both major and minor versions.
	MobileDefaultDisplayFormUrl	Retrieves the default mobile display form server relative URL for this list object.
	MobileDefaultEditFormUrl	Retrieves the default mobile edit form server relative URL for this list object.
	MobileDefaultNewFormUrl	Retrieves the default mobile new form server relative URL for this list object.
	MobileDefaultView	Read-only property used to retrieve the mobile default view for the list.
	MobileDefaultViewUrl	Gets the URL of the default mobile view for the list.
	MultipleDataList	Gets or sets a Boolean value that specifies whether the list in a Meeting Workspace site contains data for multiple meeting instances within the site.
	NavigateForFormsPages	Indicates whether to navigate for forms pages or use a modal dialog.
	NeedUpdateSiteClientTag	A boolean value that determines whether to editing documents in this list should increment the ClientTag for the site. The tag is used to allow clients to cache JS/CSS/resources that are retrieved from the Content DB, including custom CSR templates
	NoCrawl	Gets or sets a Boolean value specifying whether crawling is enabled for the list.
	OnQuickLaunch	Gets or sets a Boolean value that specifies whether the list appears on the Quick Launch area of the home page.
	Ordered	Gets or sets a Boolean value that specifies whether the option to allow users to reorder items in the list is available on the Edit View page for the list.
	ParentWeb	Gets the parent Web site for the list.
	ParentWebUrl	Gets the URL of the parent Web site for the list.
	Permissions	Obsolete. Use the RoleAssignments() property instead, to get the collection of role assignments for the list. For more information, see Authorization object model. (In Windows SharePoint Services 2.0, the Permissions property returned the collection of permission objects that represented all the permissions for the list and is maintained for backward compatibility.)
	PropertiesXml	Gets a fragment in Collaborative Application Markup Language (CAML) schemas that specifies property values for the list.
	ReadOnlyUI	A boolean value that indicates whether the UI for this list should be presented in a read-only fashion. This will not affect security nor will it actually prevent changes to the list from occurring - it only affects the way the UI is displayed.
	ReadSecurity	Gets or sets the Read security setting for the list.
	RequestAccessEnabled	Gets or sets a Boolean value that specifies whether the option to allow users to request access to the list is available.
	RestrictedTemplateList	Gets a Boolean value that indicates whether access to the template list is restricted.
	RestrictUserUpdates	A boolean value that indicates whether the this list is a restricted one or not The value can't be changed if there are existing items in the list
	ReusableAcl	Gets an opaque object that represents the raw access control list (ACL) information for the list. (Overrides SPSecurableObject.ReusableAcl.)
	RoleAssignments	Gets the role assignments for this securable object. (Inherited from SPSecurableObject.)
	RootFolder	Gets the folder that contains all the files that are used in working with the list.
	RootWebOnly	Property that indicates whether the option to allow deployment to root Webs only.
	SchemaXml	Gets the schema in Collaborative Application Markup Language (CAML) schemas that defines the list.
	SchemaXmlInCurrentUICulture	Read-only property used to retrieve the current UI culture XML schema.
	SendToLocationName	Gets or sets a file name to use when copying an item in the list to another document library.
	SendToLocationUrl	Gets or sets a URL to use when copying an item in the list to another document library.
	ServerTemplateCanCreateFolders	Gets a Boolean value that specifies whether server template folder creation is enabled for the list.
	ShowUser	Gets or sets a Boolean value that specifies whether names of users are shown in the results of the survey.
	SmsAlertTemplate	Gets or sets the template used by the list for Short Message Service (SMS) alerts.
	TemplateFeatureId	Gets the globally unique identifier (GUID) of a template feature that is associated with the list.
	Title	Gets or sets the displayed title for the list.
	TitleResource	Gets an SPUserResource object that represents the translations for the title of the list.
	UseFormsForDisplay	Indicates whether forms should be considered for display context or not.
	UserCustomActions	Gets the collection of user custom actions defined on the list.
	UserResources	Gets the collection of user-defined localized resources scoped to the list.
	ValidationFormula	Gets or sets a formula that is evaluated each time that a list item is added or updated.
	ValidationMessage	Gets or sets the message that is displayed when validation fails for a list item.
	Version	Gets the version number of the list.
	Views	Gets the collection of view objects that represents all the views of the list.
	WorkflowAssociations	Gets the collection of workflow association objects that represents all the workflows that are associated with the list.
	WriteSecurity	Gets or sets the Write security setting for the list.

Top

Methods

	Name	Description
	AddItem()	Creates a list item in the root folder of the list.
	AddItem(String, SPFileSystemObjectType)	Creates a list item of a specified type in the specified folder in the list.
	AddItem(String, SPFileSystemObjectType, String)	Creates a list item of a specified type with a specified file name in the specified folder in the list.
	AddWorkflowAssociation	Obsolete. Adds a workflow association to the list.
	AppendDataTable	Appends the results returned by a query to an existing data table.
	BreakRoleInheritance(Boolean)	Creates unique role assignments for the object and optionally copies role assignments from the parent. (Inherited from SPSecurableObject.)
	BreakRoleInheritance(Boolean, Boolean)	Creates unique role assignments for the list from the parent, optionally copies roles assignments from the parent, and optionally clears unique role assignments from descendants. (Overrides SPSecurableObject.BreakRoleInheritance(Boolean, Boolean).)
	CheckPermissions	Checks whether the current user has the specified set of permissions for the list and throws an exception if the user does not have them. (Overrides SPSecurableObject.CheckPermissions(SPBasePermissions).)
	Delete	Deletes the list.
	DoesUserHavePermissions(SPBasePermissions)	Indicates whether the current user has a specified set of permissions. (Inherited from SPSecurableObject.)
	DoesUserHavePermissions(SPBasePermissions, Boolean)	Indicates whether the current user has a specified set of permissions on the list and optionally checks permissions on the current folder.
	DoesUserHavePermissions(SPUser, SPBasePermissions)	Indicates whether the specified user has the specified set of permissions on the list.
	DoesUserHavePermissionsForUI(SPBasePermissions)
	DoesUserHavePermissionsForUI(SPBasePermissions, Boolean)	Checks the permissions for a given set of rights, as they should be displayed in the UI, and returns a Boolean. Optionally checks for permissions on a folder. This will only differ from DoesUserHavePermissions if ReadOnlyUI is set to true, and will always be as or more restrictive than DoesUserHavePermissions.
	EnsurePropsFresh	Checks the properties of the list, and, if necessary, updates them to ensure that the most current settings are used.
	EnsureRssSettings	Ensures that the RSS settings of the list are current.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetChanges()	Returns the default number of changes from the current change log for the list.
	GetChanges(SPChangeQuery)	Gets the changes to the list from the change log as filtered by the specified query.
	GetChanges(SPChangeToken)	Returns a collection of changes starting from a particular point in the change log.
	GetChanges(SPChangeToken, SPChangeToken)	Returns a collection of changes logged over a specified period of time.
	GetContentTypeIdByUrl	Returns the content type identifier (ID) for the content type with the specified URL.
	GetDataTable	Retrieves a data table that contains item data that satisfies a query.
	GetDefaultViewForContentType	Returns the default view of list data that is used by the specified content type.
	GetDirectChildContentType	Returns the content type identifier (ID) for the content type that is the direct child of the specified content type.
	GetDistinctFieldValues	Obsolete. Returns a two-dimensional object that represents an array of field values in which data duplication within a specified field in the list is eliminated and each value returned is unique.
	GetHashCode	(Inherited from Object.)
	GetItemById	Gets the list item with the specified identifier (ID).
	GetItemByIdAllFields	Returns the list item with the specified identifier (ID).
	GetItemByIdSelectedFields	Gets the list item with the specified identifier (ID) and includes only the values for the specified fields.
	GetItemByUniqueId	Gets the list item by GUID.
	GetItems([])	Returns a collection of items from the list but includes only the specified field values.
	GetItems(SPQuery)	Gets a collection of items from the list based on the specified query.
	GetItems(SPView)	Returns a collection of items from the list based on the specified view.
	GetItems(SPQuery, String)	Gets a collection of items from the list based on the specified query and view.
	GetItemsWithUniquePermissions()	Returns a collection of SPListItemInfo objects for items that have unique permissions.
	GetItemsWithUniquePermissions(Int32, Boolean)	Returns a collection of SPListItemInfo objects for items that have unique permissions by specifying the maximum number of items to return and whether to return only folder information.
	GetPropertiesXmlForUncustomizedViews	Returns properties of the uncustomized views of the list, including the GUID, the type, the display name, the URL, and the ID of the base view.
	GetRelatedFields()	Returns a collection of objects with information about a lookup field in another list that points to a field in this list.
	GetRelatedFields(SPRelationshipDeleteBehavior)	Gets a collection of objects with information about a lookup field in another list that points to a field in this list, depending upon the specified deletion constraint.
	GetType	(Inherited from Object.)
	GetUncustomizedViewByBaseViewId	Gets the view object that is associated with the specified base view identifier (ID).
	GetUserEffectivePermissionInfo	Gets detailed information about the effective permissions that a specified user has on the list and the role assignments for this user at this scope. (Overrides SPSecurableObject.GetUserEffectivePermissionInfo(String).)
	GetUserEffectivePermissions	Gets the effective permissions that a specified user has on the list. (Overrides SPSecurableObject.GetUserEffectivePermissions(String).)
	GetView	Returns a view of the list based on the specified GUID.
	IsContentTypeAllowed(SPContentType)	Verifies that the list supports the specified content type.
	IsContentTypeAllowed(SPContentTypeId)	Verifies that the list supports the specified content type.
	MemberwiseClone	(Inherited from Object.)
	Recycle	Recycles the list and returns the list's globally unique identifier (GUID).
	RemoveWorkflowAssociation	Obsolete. Removes the specified workflow association from the list.
	RenderAsHtml	Gets the results of the specified query in HTML format.
	RenderListData(String)	Returns the data for the specified query view.
	RenderListData(String, Guid)	Returns the data for the specified query view.
	RenderListFormData
	ResetRoleInheritance	Resets the role assignments of the list and all its descendant object to those of the list's parent object. (Overrides SPSecurableObject.ResetRoleInheritance().)
	SaveAsNewView	First tries to find if the view already exists. Overwrite it if yes, add a new view if no. Then extract all the adhoc filter/sort info from the URL and build and update the view's xml Returns the url of the new/overwritten view.
	SaveAsTemplate	Saves the list as a template in the list template gallery and includes the option of saving with or without the data that is contained in the current list.
	ServerTemplateCanReceiveEmail	Gets whether the specified list template and website support receiving email.
	SetAttributesForPropertiesXML	This member is reserved for internal use and is not intended to be used directly from your code.
	ToString	Returns the title of the list. (Overrides Object.ToString().)
	Update()	Updates the database with changes that are made to the list.
	Update(Boolean)	Updates the database with changes that are made to the list, optionally including changes that result from data migration.
	UpdateWorkflowAssociation	Obsolete. Updates the specified workflow association.
	WriteRssFeed(Stream)	Writes the RSS feeds from the list to the specified document stream.
	WriteRssFeed(Stream, Int32)	Writes the RSS feeds that are associated with the specified meeting to the specified document stream.
	WriteRssFeed(Stream, Int32, SPView)	Writes the RSS feeds that are associated with the specified meeting and view to the specified document stream.

Top

Fields

	Name	Description
	m_arrListProps	This member is reserved for internal use and is not intended to be used directly from your code.
	m_iRow	This member is reserved for internal use and is not intended to be used directly from your code.
	m_ListAttributesDict	This member is reserved for internal use and is not intended to be used directly from your code.
	m_Lists	This member is reserved for internal use and is not intended to be used directly from your code.
	m_Permissions	This member is reserved for internal use and is not intended to be used directly from your code.

Top

See also

Reference

SPList class

Microsoft.SharePoint namespace