SPList Members

Include Protected Members
Include Inherited Members

Represents a list on a SharePoint 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 all list roles to which the current user directly belongs, but excludes roles to which the user indirectly belongs, such as through membership in a domain group.
	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.
	CanReceiveEmail	Gets a Boolean value specifying whether the list can receive e-mail.
	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.
	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.
	DefaultItemOpen	Gets or sets a value that specifies whether to open list items in a client application or in the browser.
	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.
	Direction	Gets or sets the direction of the reading order for 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.
	EffectiveFolderPermissions	Within an HTTP context, gets the effective base permissions for folders in the list.
	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	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.
	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.
	EnableVersioning	Gets or sets a Boolean value that specifies whether versioning is enabled for the document library.
	EventReceivers	Gets the collection of event receivers that have been registered for the list.
	EventSinkAssembly	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	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	Gets or sets an arbitrary string for use by a Windows SharePoint Services 2.0 event handler for document library events.
	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.
	Fields	Gets the collection of field objects that represents all the fields in the list.
	FirstUniqueAncestor	Gets the first ancestor of the parent Web site that has unique permissions, or if HasUniqueRoleAssignments is true, gets the list itself.
	Folders	Gets the collection of folder items for the list.
	ForceCheckout	Gets or sets a Boolean value that specifies whether forced checkout is enabled for the document library.
	Forms	Gets a collection of form objects that represent the forms that are used in creating, editing, or displaying items in the list.
	HasUniqueRoleAssignments	Gets a Boolean value that specifies whether the list has unique security settings or whether it inherits its role assignments from a parent object.
	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.
	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.
	ItemCount	Gets the number of items in the list, including folders.
	Items	Gets the collection of all items in the list. This property returns all metadata of each item in the list and can greatly diminish performance. It is recommended that you instead use the GetItems() method to return items from a list, which allows you to specify which data to return.
	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.
	Lists	Gets the parent collection of lists to which the list belongs.
	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.
	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.
	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 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 Changes in the 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 Core Schemas that specifies property values for the list.
	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.
	ReusableAcl	Gets an opaque object that represents the raw access control list (ACL) information for the list.
	RoleAssignments	Gets the collection of role assignments for the list.
	RootFolder	Gets the folder that contains all the files that are used in working with the list.
	SchemaXml	Gets the schema in Collaborative Application Markup Language Core Schemas that defines the list.
	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.
	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.
	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
	AddWorkflowAssociation	Adds a workflow association to the list.
	BreakRoleInheritance	Breaks the role assignment inheritance for the list and gives the current list its own copy of the role assignments.
	CheckPermissions	Checks the permissions for the list and throws UnauthorizedAccessException if the current user does not have the specified set of rights.
	Delete	Deletes the list.
	DoesUserHavePermissions(SPBasePermissions)	Checks the permissions of the current user on the list.
	DoesUserHavePermissions(SPBasePermissions, Boolean)	Checks the permissions of the list, and, optionally. checks the folder permissions.
	DoesUserHavePermissions(SPUser, SPBasePermissions)	Checks the permissions of a specified user on the list.
	EnsurePropsFresh	Checks the properties of the list, and, if necessary, updates them to ensure that the most current settings are used.
	EnsureRssSettings	Checks the RSS settings of the list, and, if necessary, updates them to ensure that the most current settings are used.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetChanges()	Returns the first 1000 changes in the current change log for the list.
	GetChanges(SPChangeQuery)	Returns a collection of changes from the change log 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 for the content type with the specified URL.
	GetDefaultViewForContentType	Returns the default view of list data that is used by the specified content type.
	GetDirectChildContentType	Returns the content type identifier for the content type that is the direct child of the specified content type.
	GetDistinctFieldValues	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	Returns the list item with the specified integer ID.
	GetItemByUniqueId	Returns the list item that is associated with the specified global unique identifier (GUID).
	GetItems(SPQuery)	Returns a collection of items from the list based on the specified query.
	GetItems(SPView)	Returns a collection of list items from the list based on the specified view.
	GetItems(SPQuery, String)	Returns a collection of list items from the list based on the specified query and view.
	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.
	GetType	(Inherited from Object.)
	GetUncustomizedViewByBaseViewId	Returns the view object that is associated with the specified base view identifier.
	GetUserEffectivePermissionInfo	Gets an object with detailed information about the effective permissions that a specified user has on the list and the role assignments for this user at this scope.
	GetUserEffectivePermissions	Gets the effective permissions that a specified user has on the list.
	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	Removes the specified workflow association from the list.
	RenderAsHtml	Returns a string representation of the specified query in HTML format.
	ResetRoleInheritance	Removes the local role assignments and reverts to role assignments from the parent list.
	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	Returns a Boolean value that specifies whether the specified list template and Web site support receiving e-mail.
	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	Updates the specified workflow assocation.
	WriteRssFeed(Stream)	Writes the RSS feeds from the list to the specified document stream.
	WriteRssFeed(Stream, Int32)	Writes the RSS feeds from the list that are associated with the specified meeting to the specified document stream.
	WriteRssFeed(Stream, Int32, SPView)	Writes the RSS feeds from the list 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