SPList 成员

代表Microsoft SharePoint Foundation Web 网站上的列表。

SPList 类型公开以下成员。

属性

	名称	说明
	AlertTemplate	获取或设置通知列表中使用的模板。
	AllowContentTypes	如果列表支持内容类型，则返回true 。
	AllowDeletion	获取或设置一个Boolean值，指定是否可以删除列表。
	AllowEveryoneViewItems	获取或设置一个Boolean值，指定是否所有人都可以查看文档中的文档库或列表中的项目的附件。
	AllowMultiResponses	获取或设置一个Boolean值，指定是否允许用户授予对调查的多个响应。
	AllowRssFeeds	获取Boolean值，该值指定列表是否允许 RSS 源。
	AllRolesForCurrentUser	Gets a full list of role definitions on the object to which the current user belongs on this scope. （从 SPSecurableObject 继承。）
	AnonymousPermMask	已过时。已过时。使用AnonymousPermMask64属性来获取或设置而不是列表的匿名用户的基本权限。（在Windows SharePoint Services 2.0， AnonymousPermMask属性获取或设置列表的匿名用户的权限。）
	AnonymousPermMask64	获取或设置列表的匿名用户的基本权限。
	Audit	获取与列表相关联的审核日志。
	Author	获取一个SPUser对象，表示列表的创建的用户的相关信息。
	BaseTemplate	获取列表所基于的列表定义类型。
	BaseType	获取或设置一个值，该值指定新列表视图在列表视图的可视页面上显示的最大列表项数。
	BrowserFileHandling	指示列表文件处理模式。
	CalculationOptions	指示选项如何计算字段公式、 列表数据验证公式和默认值公式计算的列表。
	CanReceiveEmail	获取一个Boolean值，该值指定列表是否可以接收电子邮件。
	ClientFormListData	返回一个字典，其中包含 CSR 表单中使用的列表属性
	ContentTypes	将可枚举数组转换为
	ContentTypesEnabled	获取或设置一个Boolean值，指定是否对列表启用内容类型。
	Created	获取的创建日期和时间的列表。
	CurrentChangeToken	获取将使用日志下一处修订记录到列表中的更改令牌。
	DataSource	获取列表，其中包含外部数据源的数据源。
	DefaultApprovalWorkflowId	已过时。请改用DefaultContentApprovalWorkflowId属性。
	DefaultContentApprovalWorkflowId	获取或设置用于管理列表的内容审批流程工作流关联的全局唯一标识符 (GUID)。
	DefaultDisplayFormUrl	获取或设置用于显示列表项的默认窗体的 URL。
	DefaultEditFormUrl	获取或设置编辑列表项的默认窗体的 URL。
	DefaultItemOpen	获取或设置一个值，它指定是否在客户端应用程序或浏览器中打开列表项。
	DefaultItemOpenUseListSetting	此属性指示是否对DefaultItemOpen （BrowserEnabledDocuments设置） 的 Web 应用程序中使用的列表设置或服务器范围的设置。
	DefaultNewFormUrl	获取或设置用于创建新列表项的默认窗体的 URL。
	DefaultView	获取列表的默认视图。
	DefaultViewUrl	获取文章的显示文本。
	Description	获取或设置列表的说明。
	DescriptionResource	获取一个SPUserResource对象，表示列表的说明的翻译。
	Direction	获取或设置列表的阅读次序的方向。
	DisableGridEditing	有关分配或检索网格编辑列表上的属性。
	DraftVersionVisibility	获取或设置一个值，它确定哪些用户可以查看列表中的文档草稿的次要版本的用户的类型。
	EffectiveBasePermissions	获取当前用户的有效基准权限列表中，包括其组成员身份和策略。 （覆盖 SPSecurableObject.EffectiveBasePermissions。）
	EffectiveBasePermissionsForUI	获取它们应在 UI 中显示当前用户的有效基本权限。 这将仅不同于 EffectiveBasePermissions 如果 ReadOnlyUI 设置为 true，并且在所有情况下将 EffectiveBasePermissions 的子集。若要将其放另一种方法，EffectiveBasePermissionsForUI 将始终作为或比 EffectiveBasePermissions 更严格。
	EffectiveFolderPermissions	在 HTTP 上下文中，获取列表中的文件夹的有效基本权限。
	EffectiveFolderPermissionsForUI	指定的文件夹列表中获取当前用户的 UI 的有效基本权限。 这将仅不同于 EffectiveFolderPermissions 如果 ReadOnlyUI 设置为 true，并且在所有情况下将 EffectiveFolderPermissions 的子集。若要将其放另一种方法，EffectiveFolderPermissionsForUI 将始终作为或比 EffectiveFolderPermissions 更严格。
	EmailAlias	如果启用电子邮件通知，则获取或设置要用于工作分配已更改或已更新项目时通知给项目所有者的电子邮件地址。
	EnableAssignToEmail	获取或设置一个Boolean值，指定是否对列表启用电子邮件通知。
	EnableAttachments	获取或设置一个Boolean值，它指定是否可以将附件添加到列表中的项目。
	EnableDeployingList	已过时。获取或设置一个Boolean值，指定是否可以部署列表。
	EnableDeployWithDependentList	获取或设置Boolean值，该值指定列表是否可以部署与相关的列表。
	EnableFolderCreation	获取或设置一个Boolean值，它指定是否可为列表创建文件夹。
	EnableMinorVersions	获取或设置一个Boolean值，指定的文档库启用版本控制后是否启用次要版本。
	EnableModeration	获取或设置一个Boolean值，它指定是否对列表启用内容审批。
	EnablePeopleSelector	启用事件列表上的用户选择器。
	EnableResourceSelector	启用事件列表上的资源选择器。
	EnableSchemaCaching	获取或设置一个Boolean值，指定是否对列表启用架构缓存。
	EnableSyndication	获取或设置一个Boolean值，它指定是否对列表启用 RSS 整合。
	EnableThrottling	指示是否启用此列表限制。
	EnableVersioning	获取或设置一个Boolean值，它指定是否对文档库启用版本控制。
	EnforceDataValidation	获取或设置一个值，指示项目中添加或更新时是否强制执行某些字段属性。
	EntityTypeName	实体类型名称。
	EventReceivers	列表中获取的已注册的事件接收器的集合。
	EventSinkAssembly	已过时。获取或设置为文档库事件提供事件处理程序的Windows SharePoint Services 2.0全局程序集缓存中的文件的强名称。
	EventSinkClass	已过时。获取或设置定义Windows SharePoint Services 2.0事件处理程序文档库事件的类的完全限定、 区分大小写的名称。
	EventSinkData	已过时。获取或设置一个任意字符串，用于通过Windows SharePoint Services 2.0事件处理程序文档库事件。
	ExcludeFromOfflineClient	获取或设置一个值，指示是否应在脱机同步到客户端下载列表。
	ExcludeFromTemplate	获取一个Boolean值，该值指示列表保存为列表模板时，或指向列表所属的网站保存为网站模板时是否包含列表的内容。
	FetchPropertyBagForListView	指定是否属性袋信息，当在客户端呈现列表时检索 JSON） 的列表架构的一部分。
	FieldIndexes	获取列表上定义的字段索引的集合。
	Fields	获取表示列表中的所有字段的 field 对象的集合。
	FirstUniqueAncestor	已过时。Use the FirstUniqueAncestorSecurableObject property instead. （从 SPSecurableObject 继承。）
	FirstUniqueAncestorSecurableObject	获取角色分配此列表定义的位置的对象。 （覆盖 SPSecurableObject.FirstUniqueAncestorSecurableObject。）
	Folders	获取列表文件夹项的集合。
	Followable	可以按照活动源中的列表吗？
	ForceCheckout	获取或设置一个Boolean值，它指定是否对文档库启用强制签出。
	ForceDefaultContentType	指定是否我们要返回的默认文档根内容类型。
	Forms	获取表示在创建、 编辑或显示在列表中的项目中使用的窗体的窗体对象的集合。
	HasExternalDataSource	获取一个值，该值指示列表是否具有外部数据源。
	HasUniqueRoleAssignments	Indicates whether the object has unique role assignments or inherits its role assignments from a parent object. （从 SPSecurableObject 继承。）
	Hidden	获取或设置Boolean值，该值指定列表是否处于隐藏状态。
	ID	获取在数据库中标识列表的 GUID。
	ImageUrl	获取表示列表的图标相对于服务器的 URL。
	IndexedRootFolderPropertyKeys	获取需要通过网站数据 Web 服务公开的根文件夹属性的属性键集。
	InformationRightsManagementSettings	文档库的信息权限管理 (IRM) 设置
	IrmEnabled	获取或设置一个Boolean值，它指定是否对列表启用信息权限管理 (IRM)。
	IrmExpire	获取或设置一个Boolean值，它指定是否对列表启用信息权限管理 (IRM) 过期。
	IrmReject	获取或设置一个Boolean值，它指定是否对列表启用信息权限管理 (IRM) 拒绝。
	IsApplicationList	指示是否此列表或不应视为一个级别的顶部导航对象。
	IsPrivate	获取一个布尔值，该值指示是否文档库的解决方案如为具有受限权限的专用列表。
	IsSiteAssetsLibrary	指示此列表被指定为图像或其他文件的用户将上载到其 wiki 页面的默认资源位置。
	IsThrottled	获取一个值，该值指示是否总项目数超过上限为列表设置。
	ItemCount	在列表中，其中包括文件夹中获取项的数目。
	Items	获取列表中的所有项的筛选的集合。
	LastItemDeletedDate	获取的日期和上次删除列表中的项目的时间。
	LastItemModifiedDate	获取的日期和时间上次修改项、 字段或列表的属性。
	ListItemEntityTypeFullName	实体类型的完整名称列表中的列表项。
	Lists	获取父集合中的列表所属的列表。
	ListViewWebPartKey	这是列表视图 Web 部件的 Web 部件键。
	MajorVersionLimit	获取或设置的最大允许与主要版本仅使用版本控制文档库中的项目的主要版本数。
	MajorWithMinorVersionsLimit	获取或设置的最大允许的主要和次要版本中使用版本控制文档库中的项目的主要版本数。
	MobileDefaultDisplayFormUrl	检索此列表对象的默认移动显示表单服务器相对 URL。
	MobileDefaultEditFormUrl	检索此列表对象的默认移动编辑表单服务器相对 URL。
	MobileDefaultNewFormUrl	检索的默认移动新窗体服务器相对 URL 为此列表对象。
	MobileDefaultView	用于检索列表的默认移动视图的只读属性。
	MobileDefaultViewUrl	获取列表的默认移动视图的 URL。
	MultipleDataList	获取或设置一个Boolean值，指定会议工作区网站中的列表是否包含网站内的多个会议实例的数据。
	NavigateForFormsPages	指示是否导航窗体页或使用模式对话框。
	NeedUpdateSiteClientTag	一个布尔值确定是否向此列表中的编辑文档时，应该增加网站 ClientTag。 该标记用于允许缓存 JS/CSS/资源从内容数据库，包括自定义 CSR 模板检索到的客户端
	NoCrawl	获取或设置一个Boolean值，指定是否为列表启用爬网。
	OnQuickLaunch	获取或设置一个Boolean值，该值指定列表是否出现在主页页上的快速启动区域。
	Ordered	获取或设置一个Boolean值，它指定是否允许用户对列表中的项目重新排序的选项是列表的编辑视图页面上可用。
	ParentWeb	获取父网站的列表。
	ParentWebUrl	获取父网站的 URL 的列表。
	Permissions	已过时。Use the RoleAssignments() property instead, to get the collection of role assignments for the list. For more information, see Changes in the Authorization Object Model. (In Windows SharePoint Services 2.0, the Permissions property returned the collection of permission objects that represented all the permissions for the list and is maintained for backward compatibility.)
	PropertiesXml	Gets a fragment in Collaborative Application Markup Language that specifies property values for the list.
	ReadOnlyUI	一个布尔值，该值指示是否应以只读方式显示此列表的 UI。这将不会影响安全性也不会它实际上阻止更改到列表发生-只会影响用户界面的显示的方式。
	ReadSecurity	获取或设置列表的读取安全设置。
	RequestAccessEnabled	获取或设置一个Boolean值，它指定是否允许用户请求访问列表的选项才可用。
	RestrictedTemplateList	获取一个Boolean值，该值指示是否仅限访问模板列表。
	RestrictUserUpdates	一个布尔值，该值指示此列表是否是一个受限或不能更改不是值，如果列表中有现有项目
	ReusableAcl	获取一个代表列表的原始访问控制列表 (ACL) 信息的不透明对象。 （覆盖 SPSecurableObject.ReusableAcl。）
	RoleAssignments	Gets the role assignments for this securable object. （从 SPSecurableObject 继承。）
	RootFolder	获取包含在使用的列表中使用的所有文件的文件夹。
	RootWebOnly	指示是否允许部署以根的选项仅 Webs 属性。
	SchemaXml	Gets the schema in Collaborative Application Markup Language that defines the list.
	SchemaXmlInCurrentUICulture	用于检索当前 UI 区域性 XML 架构的只读属性。
	SendToLocationName	获取或设置要在列表中的项目复制到另一个文档库时使用的文件名。
	SendToLocationUrl	获取或设置要在列表中的项目复制到另一个文档库时使用的 URL。
	ServerTemplateCanCreateFolders	获取Boolean值，该值指定是否对列表启用模板文件夹创建的服务器。
	ShowUser	获取或设置一个Boolean值，它指定是否在调查结果中显示的用户的名称。
	SmsAlertTemplate	获取或设置使用短信服务 (SMS) 通知列表的模板。
	TemplateFeatureId	获取与列表相关联的模板功能的全局唯一标识符 (GUID)。
	Title	reservemember
	TitleResource	获取一个SPUserResource对象，表示列表的标题的翻译。
	UseFormsForDisplay	指示表单是否应当显示上下文或不考虑。
	UserCustomActions	获取列表上定义的用户自定义操作的集合。
	UserResources	获取列表范围内的用户定义的本地化资源的集合。
	ValidationFormula	获取或设置进行求值每次添加或更新列表项的公式。
	ValidationMessage	获取或设置列表项验证失败时显示的消息。
	Version	获取列表的版本号。
	Views	获取表示列表的所有视图的 view 对象的集合。
	WorkflowAssociations	获取工作流的集合代表所有与列表关联工作流的关联对象。
	WriteSecurity	获取或设置列表的写入安全设置。

页首

方法

	名称	说明
	AddItem()	列表的根文件夹中创建列表项。
	AddItem(String, SPFileSystemObjectType)	在列表中指定的文件夹中创建指定类型的列表项。
	AddItem(String, SPFileSystemObjectType, String)	使用指定的文件名称列表中指定的文件夹中创建指定类型的列表项。
	AddWorkflowAssociation	已过时。向列表添加工作流关联。
	AppendDataTable	将追加到现有的模拟运算表的查询返回的结果。
	BreakRoleInheritance(Boolean)	Creates unique role assignments for the object and optionally copies role assignments from the parent. （从 SPSecurableObject 继承。）
	BreakRoleInheritance(Boolean, Boolean)	从父创建列表的唯一角色分配、 （可选） 从父，复制角色分配和 （可选） 清除从后代唯一角色分配。 （覆盖 SPSecurableObject.BreakRoleInheritance(Boolean, Boolean)。）
	CheckPermissions	检查当前用户是否具有指定的列表的权限集，并将引发异常，如果用户不具有这些。 （覆盖 SPSecurableObject.CheckPermissions(SPBasePermissions)。）
	Delete	删除列表。
	DoesUserHavePermissions(SPBasePermissions)	Indicates whether the current user has a specified set of permissions. （从 SPSecurableObject 继承。）
	DoesUserHavePermissions(SPBasePermissions, Boolean)	指示当前用户是否具有列表上的一组指定的权限和 （可选） 检查当前文件夹的权限。
	DoesUserHavePermissions(SPUser, SPBasePermissions)	指示指定的用户是否在列表上具有指定的权限集。
	DoesUserHavePermissionsForUI(SPBasePermissions)
	DoesUserHavePermissionsForUI(SPBasePermissions, Boolean)	当他们应显示在用户界面，并返回一个布尔值，请检查一组给定的权限的权限。（可选） 检查文件夹的权限。这将仅不同于 DoesUserHavePermissions 如果 ReadOnlyUI 设置为 true，并将始终为或比 DoesUserHavePermissions 更严格。
	EnsurePropsFresh	检查列表中的属性，并如有必要，更新它们以确保将使用的最新的设置。
	EnsureRssSettings	确保当前列表的 RSS 设置。
	Equals	（从 Object 继承。）
	Finalize	（从 Object 继承。）
	GetChanges()	从列表中的当前更改日志中返回所做更改的默认号码。
	GetChanges(SPChangeQuery)	从更改日志中，如按指定的查询筛选到列表中获取所做的更改。
	GetChanges(SPChangeToken)	返回从更改日志中的特定位置开始所做更改的集合。
	GetChanges(SPChangeToken, SPChangeToken)	返回指定的一段时间记录所做更改的集合。
	GetContentTypeIdByUrl	返回具有指定 URL 的内容类型的内容类型标识符 (ID)。
	GetDataTable	检索包含满足查询的项目数据的模拟运算表。
	GetDefaultViewForContentType	返回由指定的内容类型的列表数据的默认视图。
	GetDirectChildContentType	返回指定的内容类型的直接子级的内容类型的内容类型标识符 (ID)。
	GetDistinctFieldValues	已过时。返回一个代表中去掉了重复的指定字段在列表中的数据的字段值和每个值的数组的二维对象返回是唯一的。
	GetHashCode	（从 Object 继承。）
	GetItemById	获取具有指定标识符 (ID) 的列表项。
	GetItemByIdAllFields	返回具有指定标识符 (ID) 的列表项。
	GetItemByIdSelectedFields	获取具有指定标识符 (ID) 的列表项，并包括仅指定字段的值。
	GetItemByUniqueId	获取由 GUID 的列表项。
	GetItems([])	从列表返回项的集合，但包括仅指定的字段值。
	GetItems(SPQuery)	从基于指定的查询列表中获取项的集合。
	GetItems(SPView)	从基于指定的视图列表中返回的项的集合。
	GetItems(SPQuery, String)	从基于指定的查询和视图列表中获取项的集合。
	GetItemsWithUniquePermissions()	返回具有唯一权限的项目的SPListItemInfo对象的集合。
	GetItemsWithUniquePermissions(Int32, Boolean)	返回由指定要返回的项，以及是否只返回文件夹信息的最大数目具有唯一权限的项目的SPListItemInfo对象的集合。
	GetPropertiesXmlForUncustomizedViews	返回非自定义视图的列表，包括 GUID、 类型、 显示名称、 URL 和基本视图的 ID 的属性。
	GetRelatedFields()	返回指向此列表中的字段的另一个列表中的信息的查阅字段的对象的集合。
	GetRelatedFields(SPRelationshipDeleteBehavior)	获取与另一个指向此列表中，具体取决于指定的删除约束中的字段的列表中的查阅字段的相关信息的对象的集合。
	GetType	（从 Object 继承。）
	GetUncustomizedViewByBaseViewId	获取与指定的基本视图标识符 (ID) 相关联的视图对象。
	GetUserEffectivePermissionInfo	获取指定的用户在此范围具有对列表和为此用户的角色分配的有效权限的详细的信息。 （覆盖 SPSecurableObject.GetUserEffectivePermissionInfo(String)。）
	GetUserEffectivePermissions	获取指定的用户具有列表的有效权限。 （覆盖 SPSecurableObject.GetUserEffectivePermissions(String)。）
	GetView	返回基于指定 GUID 的列表视图。
	IsContentTypeAllowed(SPContentType)	验证列表支持指定的内容类型。
	IsContentTypeAllowed(SPContentTypeId)	验证列表支持指定的内容类型。
	MemberwiseClone	（从 Object 继承。）
	Recycle	回收列表并返回列表的全局唯一标识符 (GUID)。
	RemoveWorkflowAssociation	已过时。从列表中删除指定的工作流关联。
	RenderAsHtml	获取指定的查询的结果以 HTML 格式。
	RenderListData(String)	返回指定的查询视图的数据。
	RenderListData(String, Guid)	返回指定的查询视图的数据。
	RenderListFormData
	ResetRoleInheritance	重置为那些列表的父对象的列表以及其所有后代对象的角色分配。 （覆盖 SPSecurableObject.ResetRoleInheritance()。）
	SaveAsNewView	首先尝试查找视图是否已存在。覆盖它，如果是，如果没有添加一个新视图。 然后提取所有即席筛选/排序 URL 中的信息以及生成和更新视图的 xml 返回覆盖新/视图的 url。
	SaveAsTemplate	将列表另存为列表模板库中的模板和当前列表中包括的使用或不包含数据的保存选项。
	ServerTemplateCanReceiveEmail	获取是否指定的列表模板和网站支持接收电子邮件。
	SetAttributesForPropertiesXML	此成员仅供内部使用，不能直接在您的代码中使用。
	ToString	返回列表的标题。 （覆盖 Object.ToString()。）
	Update()	使用对列表所做的更改更新数据库。
	Update(Boolean)	使用对列表中，也可以包括因迁移数据的更改所做的更改更新数据库。
	UpdateWorkflowAssociation	已过时。更新指定工作流关联。
	WriteRssFeed(Stream)	将写入到指定的文档流，RSS 源从列表中。
	WriteRssFeed(Stream, Int32)	写入 RSS 源与指定会议到指定的文档流相关联。
	WriteRssFeed(Stream, Int32, SPView)	写入 RSS 源与指定的会议和视图应用于指定的文档流相关联。

页首

域

	名称	说明
	m_arrListProps	此成员仅供内部使用，不能直接在您的代码中使用。
	m_iRow	此成员仅供内部使用，不能直接在您的代码中使用。
	m_ListAttributesDict	此成员仅供内部使用，不能直接在您的代码中使用。
	m_Lists	此成员仅供内部使用，不能直接在您的代码中使用。
	m_Permissions	此成员仅供内部使用，不能直接在您的代码中使用。

页首

另请参阅

引用

SPList 类

Microsoft.SharePoint 命名空间