List members

Represents a list on a SharePoint Web site.

The List type exposes the following members.

Constructors

	Name	Description
	List	Initializes a new instance of the List object.

Top

Properties

	Name	Description
	AllowContentTypes	Gets a value that specifies whether the list supports content types.
	AllowDeletion
	BaseTemplate	Gets the list definition type on which the list is based.
	BaseType	Gets the base type for the list.
	BrowserFileHandling	Gets a value that specifies the override of the web application’s BrowserFileHandling property at the list level.
	ContentTypes	Gets the content types that are associated with the list.
	ContentTypesEnabled	Gets or sets a value that specifies whether content types are enabled for the list.
	Context	Returns the context that is associated with the client object. (Inherited from ClientObject.)
	CrawlNonDefaultViews
	CreatablesInfo
	Created	Gets a value that specifies when the list was created.
	CurrentChangeToken
	CustomActionElements
	DataSource	Gets the data source associated with the list, or a null reference (Nothing in Visual Basic) if the list is not a virtual list.
	DefaultContentApprovalWorkflowId	Gets or sets a value that specifies the default workflow identifier for content approval on the list.
	DefaultDisplayFormUrl	Gets or sets a value that specifies the location of the default display form for the list.
	DefaultEditFormUrl	Gets or sets a value that specifies the URL of the edit form to use for list items in the list.
	DefaultItemOpenUseListSetting
	DefaultNewFormUrl	Gets or sets a value that specifies the location of the default new form for the list.
	DefaultView
	DefaultViewPath
	DefaultViewUrl	Gets the URL of the default view for the list.
	Description	Gets or sets a value that specifies the description of the list.
	DescriptionResource
	Direction	Gets or sets a value that specifies the reading order of the list.
	DocumentTemplateUrl	Gets or sets a value that specifies the server-relative URL of the document template for the list.
	DraftVersionVisibility	Gets or sets a value that specifies the minimum permission required to view minor versions and drafts within the list.
	EffectiveBasePermissions	Gets a value that specifies the effective permissions on the list that are assigned to the current user.
	EffectiveBasePermissionsForUI
	EnableAssignToEmail
	EnableAttachments	Gets or sets a value that specifies whether list item attachments are enabled for the list.
	EnableFolderCreation	Gets or sets a value that specifies whether new list folders can be added to the list.
	EnableMinorVersions	Gets or sets a value that specifies whether minor versions are enabled for the list.
	EnableModeration	Gets or sets a value that specifies whether content approval is enabled for the list.
	EnableVersioning	Gets or sets a value that specifies whether historical versions of list items and documents can be created in the list.
	EntityTypeName
	EventReceivers
	ExcludeFromOfflineClient
	ExemptFromBlockDownloadOfNonViewableFiles
	Fields	Gets a value that specifies the collection of all fields in the list.
	FileSavePostProcessingEnabled
	FirstUniqueAncestorSecurableObject	Gets the object where role assignments for this object are defined. (Inherited from SecurableObject.)
	ForceCheckout
	Forms	Gets a value that specifies the collection of all list forms in the list.
	HasExternalDataSource	Gets a value that specifies whether the list is an external list.
	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.)
	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.
	ImagePath
	ImageUrl	Gets a value that specifies the URI for the icon of the list.
	InformationRightsManagementSettings
	IrmEnabled
	IrmExpire
	IrmReject
	IsApplicationList	Gets or sets a value that specifies a flag that a client application can use to determine whether to display the list.
	IsCatalog	Gets a value that specifies whether the list is a gallery.
	IsEnterpriseGalleryLibrary
	IsPrivate
	IsSiteAssetsLibrary
	IsSystemList
	ItemCount	Gets a value that specifies the number of list items in the list.
	LastItemDeletedDate	Gets a value that specifies the last time a list item was deleted from the list.
	LastItemModifiedDate	Gets a value that specifies the last time a list item, field, or property of the list was modified.
	LastItemUserModifiedDate
	ListExperienceOptions
	ListItemEntityTypeFullName
	MajorVersionLimit
	MajorWithMinorVersionsLimit
	MultipleDataList
	NoCrawl	Gets or sets a value that specifies that the crawler must not crawl the list.
	ObjectData	Gets the object data for the current client object. (Inherited from ClientObject.)
	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.)
	OnQuickLaunch	Gets or sets a value that specifies whether the list appears on the Quick Launch of the site.
	PageRenderType
	ParentWeb	Gets a value that specifies the site that contains the list.
	ParentWebPath
	ParentWebUrl	Gets a value that specifies the server-relative URL of the site that contains the list.
	ParserDisabled
	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.)
	ReadSecurity
	RoleAssignments	Gets the role assignments for the securable object. (Inherited from SecurableObject.)
	RootFolder	Gets the root folder that contains the files in the list and any related files.
	SchemaXml	Gets a value that specifies the list schema of the list.
	ServerObjectIsNull	Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
	ServerTemplateCanCreateFolders
	Tag	Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
	TemplateFeatureId	Gets a value that specifies the feature identifier of the feature that contains the list schema for the list.
	Title	Gets or sets the displayed title for the list.
	TitleResource
	TypedObject	Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
	UserCustomActions	Gets a value that specifies the collection of all user custom actions for the list.
	ValidationFormula	Gets or sets a value that specifies the data validation criteria for a list item.
	ValidationMessage	Gets or sets a value that specifies the error message returned when data validation fails for a list item.
	Views	Gets a value that specifies the collection of all public views on the list and personal views of the current user on the list.
	WorkflowAssociations	Gets a value that specifies the collection of all workflow associations for the list.
	WriteSecurity

Top

Methods

	Name	Description
	AddItem	Creates a new list item in the list.
	AddItemUsingPath
	BreakRoleInheritance	Creates unique role assignments for the securable object. (Inherited from SecurableObject.)
	CheckUninitializedProperty	Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
	CreateDocument
	CreateDocumentAndGetEditLink
	CreateDocumentFromTemplate
	CreateDocumentFromTemplateBytes
	CreateDocumentFromTemplateStream
	CreateDocumentFromTemplateUsingPath
	CreateDocumentWithDefaultName
	CreateMappedView
	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.)
	DeleteObject	Deletes the list.
	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.)
	GetBloomFilter
	GetBloomFilterWithCustomFields
	GetChanges	Returns the collection of changes from the change log that have occurred within the list, based on the specified query.
	GetItemById(Int32)	Returns the list item with the specified list item identifier.
	GetItemById(String)
	GetItemByUniqueId
	GetItems	Returns a collection of items from the list based on the specified query.
	GetListDataAsStream
	GetMappedApp
	GetMappedApps
	GetRelatedFields	Returns a collection of lookup fields that use this list as a data source and that have FieldLookup.IsRelationship set to true.
	GetSpecialFolderUrl
	GetUserEffectivePermissions
	GetView	Returns the list view with the specified view identifier.
	GetWebDavUrl
	InitNonPropertyFieldFromJson	Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	InitOnePropertyFromJson	(Overrides SecurableObject.InitOnePropertyFromJson(String, JsonReader).)
	IsObjectPropertyInstantiated	Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
	IsPropertyAvailable	Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
	LoadExpandoFields	Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	PublishMappedView
	Recycle	Moves the list to the Recycle Bin and returns the identifier of the new Recycle Bin item.
	RefreshLoad	Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	RemoveFromParentCollection	Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
	RenderExtendedListFormData
	RenderListContextMenuData
	RenderListData
	RenderListDataAsStream
	RenderListFilterData
	RenderListFormData
	ReserveListItemId
	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.)
	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.)
	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.)
	SaveAsNewView
	SaveAsTemplate
	SetExemptFromBlockDownloadOfNonViewableFiles
	SyncFlowCallbackUrl
	SyncFlowInstance
	SyncFlowInstances
	SyncFlowTemplates
	ToString	(Inherited from Object.)
	UnpublishMappedView
	Update	Updates the database with changes that are made to the list.
	UpdateClientObjectPropertyType	Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
	ValidateAppName

Top

See also

Reference

List class

Microsoft.SharePoint.Client namespace