ListItem members

Represents an item or row in a list.

The ListItem type exposes the following members.

Constructors

  Name Description
Public method ListItem Initializes a new instance of the ListItem object.

Top

Properties

  Name Description
Public property AttachmentFiles Specifies the collection of attachments that are associated with the list item.
Public property Client_Title
Public property CommentsDisabled
Public property CommentsDisabledScope
Public property ComplianceInfo
Public property ContentType Gets a value that specifies the content type of the list item.
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property DisplayName Gets a value that specifies the display name of the list item.
Public property EffectiveBasePermissions Gets a value that specifies the effective permissions on the list item that are assigned to the current user.
Public property EffectiveBasePermissionsForUI Gets the effective base permissions for the current user, as they should be displayed in UI.
Public property FieldValues
Public property FieldValuesAsHtml Gets the values for the list item as HTML.
Public property FieldValuesAsText Gets the list item’s field values as a collection of string values.
Public property FieldValuesForEdit Gets the formatted values to be displayed in an edit form.
Public property File Gets the file that is represented by the item from a document library.
Public property FileSystemObjectType Gets a value that specifies whether the list item is a file or a list folder.
Public property FirstUniqueAncestorSecurableObject Gets the object where role assignments for this object are defined. (Inherited from SecurableObject.)
Public property Folder Gets a folder object that is associated with a folder item.
Public property GetDlpPolicyTip
Public property HasUniqueRoleAssignments Gets a value that specifies whether the role assignments are uniquely defined for this securable object or inherited from a parent securable object. (Inherited from SecurableObject.)
Public property IconOverlay
Public property Id Gets a value that specifies the list item identifier.
Public property Item
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property ObjectVersion Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property ParentList Gets the parent list that contains the list item.
Public property Path Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property Properties
Public property RoleAssignments Gets the role assignments for the securable object. (Inherited from SecurableObject.)
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property ServerRedirectedEmbedUri
Public property ServerRedirectedEmbedUrl
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
Public property Versions

Top

Methods

  Name Description
Public method BreakRoleInheritance Creates unique role assignments for the securable object. (Inherited from SecurableObject.)
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method CustomFromJson Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method DeleteObject Deletes the list item.
Public method FromJson Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method GetChanges
Public method GetHashtags
Public method GetUserEffectivePermissions Gets the effective permissions that a specified user has on the list item.
Public method GetWOPIFrameUrl Gets the full URL to the SharePoint frame page that initiates the SPWOPIAction object with the WOPI application associated with the list item.
Protected method InitNonPropertyFieldFromJson (Overrides ClientObject.InitNonPropertyFieldFromJson(String, JsonReader).)
Protected method InitOnePropertyFromJson (Overrides SecurableObject.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields (Overrides ClientObject.LoadExpandoFields().)
Public method MediaServiceUpdate
Public method OverridePolicyTip
Public method ParseAndSetFieldValue Sets the value of the field for the list item based on an implementation specific transformation of the value.
Public method Recycle Moves the list item to the Recycle Bin and returns the identifier of the new Recycle Bin item.
Public method RefreshLoad (Overrides ClientObject.RefreshLoad().)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method ResetRoleInheritance When implemented in a derived class, removes local role assignments so that role assignments, for all descendant objects, are re-inherited from the parent object. (Inherited from SecurableObject.)
Public method Retrieve() Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method Retrieve([]) Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method SetCommentsDisabled
Public method SetComplianceTag
Public method SetComplianceTagWithExplicitMetasUpdate
Public method SetComplianceTagWithHold
Public method SetComplianceTagWithNoHold
Public method SetComplianceTagWithRecord
Public method SystemUpdate
Public method ToString (Inherited from Object.)
Public method Update Commits changed properties of the list item.
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
Public method UpdateHashtags
Public method UpdateOverwriteVersion
Public method ValidateUpdateListItem

Top

See also

Reference

ListItem class

Microsoft.SharePoint.Client namespace