SPList methods
SharePoint 2013
The SPList type exposes the following members.
| 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. |
Show: