This documentation is archived and is not being maintained.

SPList Methods

Windows SharePoint Services 3

The SPList type exposes the following members.

  NameDescription
Public method AddWorkflowAssociation Adds a workflow association to the list.
Public method BreakRoleInheritance Breaks the role assignment inheritance for the list and gives the current list its own copy of the role assignments.
Public method CheckPermissions Checks the permissions for the list and throws UnauthorizedAccessException if the current user does not have the specified set of rights.
Public method Delete Deletes the list.
Public method DoesUserHavePermissions(SPBasePermissions) Checks the permissions of the current user on the list.
Public method DoesUserHavePermissions(SPBasePermissions, Boolean) Checks the permissions of the list, and, optionally. checks the folder permissions.
Public method DoesUserHavePermissions(SPUser, SPBasePermissions) Checks the permissions of a specified user on the list.
Protected method EnsurePropsFresh Checks the properties of the list, and, if necessary, updates them to ensure that the most current settings are used.
Public method EnsureRssSettings Checks the RSS settings of the list, and, if necessary, updates them to ensure that the most current settings are used.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetChanges() Returns the first 1000 changes in the current change log for the list.
Public method GetChanges(SPChangeQuery) Returns a collection of changes from the change log filtered by the specified query.
Public method GetChanges(SPChangeToken) Returns a collection of changes starting from a particular point in the change log.
Public method GetChanges(SPChangeToken, SPChangeToken) Returns a collection of changes logged over a specified period of time.
Public method GetContentTypeIdByUrl Returns the content type identifier for the content type with the specified URL.
Public method GetDefaultViewForContentType Returns the default view of list data that is used by the specified content type.
Public method GetDirectChildContentType Returns the content type identifier for the content type that is the direct child of the specified content type.
Public method 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.
Public method GetHashCode (Inherited from Object.)
Public method GetItemById Returns the list item with the specified integer ID.
Public method GetItemByUniqueId Returns the list item that is associated with the specified global unique identifier (GUID).
Public method GetItems(SPQuery) Returns a collection of items from the list based on the specified query.
Public method GetItems(SPView) Returns a collection of list items from the list based on the specified view.
Public method GetItems(SPQuery, String) Returns a collection of list items from the list based on the specified query and view.
Public method 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.
Public method GetType (Inherited from Object.)
Public method GetUncustomizedViewByBaseViewId Returns the view object that is associated with the specified base view identifier.
Public method 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.
Public method GetUserEffectivePermissions Gets the effective permissions that a specified user has on the list.
Public method GetView Returns a view of the list based on the specified GUID.
Public method IsContentTypeAllowed(SPContentType) Verifies that the list supports the specified content type.
Public method IsContentTypeAllowed(SPContentTypeId) Verifies that the list supports the specified content type.
Protected method MemberwiseClone (Inherited from Object.)
Public method Recycle Recycles the list and returns the list's globally unique identifier (GUID).
Public method RemoveWorkflowAssociation Removes the specified workflow association from the list.
Public method RenderAsHtml Returns a string representation of the specified query in HTML format.
Public method ResetRoleInheritance Removes the local role assignments and reverts to role assignments from the parent list.
Public method 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.
Public method Static member ServerTemplateCanReceiveEmail Returns a Boolean value that specifies whether the specified list template and Web site support receiving e-mail.
Protected method SetAttributesForPropertiesXML This member is reserved for internal use and is not intended to be used directly from your code.
Public method ToString Returns the title of the list. (Overrides Object.ToString().)
Public method Update() Updates the database with changes that are made to the list.
Public method Update(Boolean) Updates the database with changes that are made to the list, optionally including changes that result from data migration.
Public method UpdateWorkflowAssociation Updates the specified workflow assocation.
Public method WriteRssFeed(Stream) Writes the RSS feeds from the list to the specified document stream.
Public method WriteRssFeed(Stream, Int32) Writes the RSS feeds from the list that are associated with the specified meeting to the specified document stream.
Public method 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
Show: