SPListItem members

  • Article

Represents an item or row in a list.

The SPListItem type exposes the following members.

Properties

  Name Description
Public property AllRolesForCurrentUser Gets a full list of role definitions on the object to which the current user belongs on this scope. (Inherited from SPSecurableObject.)
Public property Attachments Gets the collection of attachments that are associated with the item.
Public property Audit Gets the audit log that is associated with the item.
Public property BackwardLinks Returns the collection of links to the item.
Public property ClientFormItemData Gets a dictionary containing item properties used in CSR forms. (Overrides SPItem.ClientFormItemData.)
Public property ContentType Gets the content type that is associated with the item.
Public property ContentTypeId Gets the identifier of the content type that is associated with this item.
Public property CopyDestinations Gets a list of URLs to which the item can be copied through the SharePoint Foundation user interface.
Public property CopyFieldMask Gets a field mask for a copied item.
Public property CopySource Gets the URL of the source item from which this item was copied, if the item results from a copy operation.
Public property DisplayName Gets the display name of the item.
Public property EffectiveBasePermissions Gets the current user’s effective base permissions on the item, including group membership and policies. (Overrides SPItem.EffectiveBasePermissions.)
Public property EffectiveBasePermissionsForUI Gets the effective base permissions for the current user, as they should be displayed in UI.
Public property Fields Gets or sets the collection of all fields in the parent of the item. (Overrides SPItem.Fields.)
Public property File Gets the file that is represented by the item from a document library.
Public property FileSystemObjectType Gets or sets the file system object type for the item.
Public property FirstUniqueAncestor Obsolete. Use the FirstUniqueAncestorSecurableObject property instead. (Inherited from SPSecurableObject.)
Public property FirstUniqueAncestorSecurableObject Retrieves the first unique ancestor if it has unique role assignments otherwise returns the first parent object (folder, list, or Web site) that has unique role assignments. (Overrides SPItem.FirstUniqueAncestorSecurableObject.)
Public property Folder Gets a folder object that is associated with a folder item.
Public property ForwardLinks Gets a collection of hyperlinks that are associated with the item; for example, the hyperlinks in a URL field or rich text field.
Public property HasPublishedVersion Gets a Boolean value that specifies whether a published version of the item exists.
Public property HasUniqueRoleAssignments Gets a Boolean value that specifies whether the item has unique security or inherits its role assignments from a parent object. (Overrides SPSecurableObject.HasUniqueRoleAssignments.)
Public property IconOverlay Gets or sets the URL to an overlay icon for this item.
Public property ID Gets the integer that identifies the item. (Overrides SPItem.ID.)
Public property Item[Guid] Gets or sets the value that is contained by the field identified by the specified GUID.
Public property Item[Int32] Gets or sets the value that is contained by the field at the specified index in the field collection of the parent list. (Overrides SPItem.Item[Int32].)
Public property Item[String] Gets or sets a field value in the item based on the field’s title, internal name, or static name. (Overrides SPItem.Item[String].)
Public property Level Gets the level of publication for the item.
Public property ListItems Gets the parent collection of list item objects to which the item belongs.
Public property MissingRequiredFields Gets a Boolean value that specifies whether required fields are missing from the item's properties.
Public property ModerationInformation Gets Content Approval information for the item, including the status and comment.
Public property Name Gets the name of the item.
Public property ParentList Gets the list that includes the list item.
Public property ProgId The Program identifier for this item.
Public property Properties Gets metadata for the item.
Public property RecurrenceID Returns the identifier (ID) of an instance of a recurrent item.
Public property ReusableAcl Gets an opaque object that represents the raw access control list (ACL) information for the item. (Overrides SPItem.ReusableAcl.)
Public property RoleAssignments Gets the role assignments for this securable object. (Inherited from SPSecurableObject.)
Public property ServerRedirected Gets a Boolean value that indicates whether users who do not have access to view the item, or who do not have the appropriate client application installed, are redirected to server-side rendering of the item when they click a link to view it.
Public property ServerRedirectedPreviewUrl Gets the URL for the thumbnail of a document in the browser, if that feature exists.
Public property SortType Gets or sets the type of this item when sorting within a view.
Public property Tasks Gets the collection of workflow tasks for the item.
Public property Title Gets the title of the item.
Public property UniqueId Gets the GUID that uniquely identifies the item for the internal database.
Public property Url Gets the site-relative URL of the item.
Public property Versions Gets the collection of item version objects that represent the versions of the item.
Public property Web Gets the Web site that is associated with the list item.
Public property Workflows Gets the collection of the workflow objects that represent instances of the item workflows that are currently running, but does not get the workflow associations.
Public property Xml Gets the data that is contained in the list item in XMLDATA format.

Top

Methods

  Name Description
Public method BreakRoleInheritance(Boolean) Creates unique role assignments for the object and optionally copies role assignments from the parent. (Inherited from SPSecurableObject.)
Public method BreakRoleInheritance(Boolean, Boolean) Creates unique role assignments for the list item, optionally copies role assignments from the parent, and optionally clears unique role assignments from descendants. (Overrides SPSecurableObject.BreakRoleInheritance(Boolean, Boolean).)
Public method CheckPermissions Determines whether the current user has a specified set of permissions. (Inherited from SPSecurableObject.)
Public methodStatic member Copy(String, String) Copies the specified version of the item to the specified destination.
Public methodStatic member Copy(String, String, Hashtable, []) Copies the specified item and its properties as a stream to the specified destination.
Public method CopyFrom(String) Overwrites the current item with the specified version of the item.
Public method CopyFrom(String, Hashtable, []) Overwrites the current item with the specified version of the item and its properties as a stream.
Public method CopyTo Copies the item to the specified destination.
Public method Delete Deletes the item. (Overrides SPItem.Delete().)
Public method DoesUserHavePermissions(SPBasePermissions) Indicates whether the current user has a specified set of permissions. (Inherited from SPSecurableObject.)
Public method DoesUserHavePermissions(SPUser, SPBasePermissions) Indicates whether the specified user has the specified permissions on an item.
Public method DoesUserHavePermissionsForUI Checks whether the specified user has the specified permissions on an item.
Public method EnsureWorkflowInformation() Checks the item's workflow information and, if necessary, updates it to ensure that the most current information is used.
Public method EnsureWorkflowInformation(Boolean, Boolean) Checks the item's workflow information and, if necessary, updates it to ensure that the most current information is used.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetFormattedValue Returns the specified field value, including formatting.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method GetUserEffectivePermissionInfo Gets detailed information about the effective permissions that a specified user has on the list item and the role assignments related to this user at this scope. (Overrides SPItem.GetUserEffectivePermissionInfo(String).)
Public method GetUserEffectivePermissions Gets the effective permissions that a specified user has on the list item. (Overrides SPItem.GetUserEffectivePermissions(String).)
Public method GetWOPIFrameUrl Gets the full URL to the SharePoint frame page that initiates the SPWOPIActionobject with the WOPI application associated with the list item.
Protected method MemberwiseClone (Inherited from Object.)
Public method Recycle Deletes the item from the content database and returns a globally unique identifier (GUID) for the transaction.
Public method ReplaceLink Replaces all instances of a specified link in the list item with a new link.
Public method ResetRoleInheritance Removes the local role assignments so that the list item, and all its descendant objects, re-inherit role assignments from the parent object. (Overrides SPSecurableObject.ResetRoleInheritance().)
Public method SystemUpdate() Updates the database with changes made to the list item without changing the Modified or Modified By fields.
Public method SystemUpdate(Boolean) Updates the database with changes that are made to the list item without changing the Modified or Modified By fields, or optionally, the item version.
Public method ToString (Inherited from Object.)
Public method UnlinkFromCopySource Clears the source item URL if the item results from a copy operation.
Public method Update Updates the database with changes that are made to the list item. (Overrides SPItem.Update().)
Public method UpdateOverwriteVersion Updates the item by creating a new minor version of the item.

Top

Fields

  Name Description
Protected field m_Fields Stores the field objects associated with the item. (Inherited from SPItem.)

Top

See also

Reference

SPListItem class

Microsoft.SharePoint namespace