Export (0) Print
Expand All

SPList Members

Windows SharePoint Services 3

Represents a list on a SharePoint Web site.

The SPList type exposes the following members.

  NameDescription
Public property AlertTemplate Gets or sets the alert template that is used by the list.
Public property AllowContentTypes Returns true if the list supports content types.
Public property AllowDeletion Gets or sets a Boolean value specifying whether the list can be deleted.
Public property AllowEveryoneViewItems Gets or sets a Boolean value specifying whether everyone can view documents in the document library or attachments to items in the list.
Public property AllowMultiResponses Gets or sets a Boolean value specifying whether users are allowed to give multiple responses to the survey.
Public property AllowRssFeeds Gets a Boolean value that specifies whether the list allows RSS feeds.
Public property AllRolesForCurrentUser Gets all list roles to which the current user directly belongs, but excludes roles to which the user indirectly belongs, such as through membership in a domain group.
Public property AnonymousPermMask Obsolete. Obsolete. Use the AnonymousPermMask64 property to get or set the base permissions for anonymous users of the list instead. (In Windows SharePoint Services 2.0, the AnonymousPermMask property got or set the permissions for anonymous users of the list.)
Public property AnonymousPermMask64 Gets or sets the base permissions for anonymous users of the list.
Public property Audit Gets the audit log that is associated with the list.
Public property Author Gets an SPUser object that represents information about the user who created the list.
Public property BaseTemplate Gets the list definition type on which the list is based.
Public property BaseType Gets the base type for the list.
Public property CanReceiveEmail Gets a Boolean value specifying whether the list can receive e-mail.
Public property ContentTypes Gets the content types that are associated with the list.
Public property ContentTypesEnabled Gets or sets a Boolean value specifying whether content types are enabled for the list.
Public property Created Gets the creation date and time for the list.
Public property CurrentChangeToken Gets the change token that will be used in logging the next change to the list.
Public property DefaultApprovalWorkflowId Obsolete. Use the DefaultContentApprovalWorkflowId property instead.
Public property DefaultContentApprovalWorkflowId Gets or sets the globally unique identifier (GUID) of a workflow association that is used to manage the Content Approval process for the list.
Public property DefaultItemOpen Gets or sets a value that specifies whether to open list items in a client application or in the browser.
Public property DefaultView Gets the default view for the list.
Public property DefaultViewUrl Gets the URL of the default view for the list.
Public property Description Gets or sets the description for the list.
Public property Direction Gets or sets the direction of the reading order for the list.
Public property DraftVersionVisibility Gets or sets a value that determines the type of user who can view minor versions of document drafts within the list.
Public property EffectiveBasePermissions Gets the effective base permissions of the current user for the list, including their group membership and policies.
Public property EffectiveFolderPermissions Within an HTTP context, gets the effective base permissions for folders in the list.
Public property EmailAlias If e-mail notification is enabled, gets or sets the e-mail address to use to notify to the owner of an item when an assignment has changed or the item has been updated.
Public property EnableAssignToEmail Gets or sets a Boolean value specifying whether e-mail notification is enabled for the list.
Public property EnableAttachments Gets or sets a Boolean value that specifies whether attachments can be added to items in the list.
Public property EnableDeployingList Gets or sets a Boolean value specifying whether the list can be deployed.
Public property EnableDeployWithDependentList Gets or sets a Boolean value that specifies whether the list can be deployed with a dependent list.
Public property EnableFolderCreation Gets or sets a Boolean value that specifies whether folders can be created for the list.
Public property EnableMinorVersions Gets or sets a Boolean value that specifies whether minor versions are enabled when versioning is enabled for the document library.
Public property EnableModeration Gets or sets a Boolean value that specifies whether Content Approval is enabled for the list.
Public property EnableSchemaCaching Gets or sets a Boolean value specifying whether schema caching is enabled for the list.
Public property EnableSyndication Gets or sets a Boolean value that specifies whether RSS syndication is enabled for the list.
Public property EnableVersioning Gets or sets a Boolean value that specifies whether versioning is enabled for the document library.
Public property EventReceivers Gets the collection of event receivers that have been registered for the list.
Public property EventSinkAssembly Gets or sets the strong name of a file in the global assembly cache that provides a Windows SharePoint Services 2.0 event handler for document library events.
Public property EventSinkClass Gets or sets the fully qualified, case-sensitive name of a class that defines a Windows SharePoint Services 2.0 event handler for document library events.
Public property EventSinkData Gets or sets an arbitrary string for use by a Windows SharePoint Services 2.0 event handler for document library events.
Public property ExcludeFromTemplate Gets a Boolean value that indicates whether the content of the list is included when the list is saved as a list template or when the site to which the list belongs is saved as a site template.
Public property Fields Gets the collection of field objects that represents all the fields in the list.
Public property FirstUniqueAncestor Gets the first ancestor of the parent Web site that has unique permissions, or if HasUniqueRoleAssignments is true, gets the list itself.
Public property Folders Gets the collection of folder items for the list.
Public property ForceCheckout Gets or sets a Boolean value that specifies whether forced checkout is enabled for the document library.
Public property Forms Gets a collection of form objects that represent the forms that are used in creating, editing, or displaying items in the list.
Public property HasUniqueRoleAssignments Gets a Boolean value that specifies whether the list has unique security settings or whether it inherits its role assignments from a parent object.
Public property Hidden Gets or sets a Boolean value that specifies whether the list is hidden.
Public property ID Gets the GUID that identifies the list in the database.
Public property ImageUrl Gets the server-relative URL for the icon that represents the list.
Public property IrmEnabled Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) is enabled for the list.
Public property IrmExpire Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) expiration is enabled for the list.
Public property IrmReject Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) rejection is enabled for the list.
Public property ItemCount Gets the number of items in the list, including folders.
Public property Items Gets the collection of all items in the list. This property returns all metadata of each item in the list and can greatly diminish performance. It is recommended that you instead use the GetItems() method to return items from a list, which allows you to specify which data to return.
Public property LastItemDeletedDate Gets the date and time that an item in the list was last deleted.
Public property LastItemModifiedDate Gets the date and time that an item, field, or property of the list was last modified.
Public property Lists Gets the parent collection of lists to which the list belongs.
Public property MajorVersionLimit Gets or sets the maximum number of major versions allowed for an item in a document library that uses version control with major versions only.
Public property MajorWithMinorVersionsLimit Gets or sets the maximum number of major versions that are allowed for an item in a document library that uses version control with both major and minor versions.
Public property MobileDefaultViewUrl Gets the URL of the default mobile view for the list.
Public property MultipleDataList Gets or sets a Boolean value that specifies whether the list in a Meeting Workspace site contains data for multiple meeting instances within the site.
Public property NoCrawl Gets or sets a Boolean value specifying whether crawling is enabled for the list.
Public property OnQuickLaunch Gets or sets a Boolean value that specifies whether the list appears on the Quick Launch of the home page.
Public property Ordered Gets or sets a Boolean value that specifies whether the option to allow users to reorder items in the list is available on the Edit View page for the list.
Public property ParentWeb Gets the parent Web site for the list.
Public property ParentWebUrl Gets the URL of the parent Web site for the list.
Public property Permissions Obsolete. 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.)
Public property PropertiesXml Gets a fragment in Collaborative Application Markup Language Core Schemas that specifies property values for the list.
Public property ReadSecurity Gets or sets the Read security setting for the list.
Public property RequestAccessEnabled Gets or sets a Boolean value that specifies whether the option to allow users to request access to the list is available.
Public property RestrictedTemplateList Gets a Boolean value that indicates whether access to the template list is restricted.
Public property ReusableAcl Gets an opaque object that represents the raw access control list (ACL) information for the list.
Public property RoleAssignments Gets the collection of role assignments for the list.
Public property RootFolder Gets the folder that contains all the files that are used in working with the list.
Public property SchemaXml Gets the schema in Collaborative Application Markup Language Core Schemas that defines the list.
Public property SendToLocationName Gets or sets a file name to use when copying an item in the list to another document library.
Public property SendToLocationUrl Gets or sets a URL to use when copying an item in the list to another document library.
Public property ServerTemplateCanCreateFolders Gets a Boolean value that specifies whether server template folder creation is enabled for the list.
Public property ShowUser Gets or sets a Boolean value that specifies whether names of users are shown in the results of the survey.
Public property TemplateFeatureId Gets the globally unique identifier (GUID) of a template feature that is associated with the list.
Public property Title Gets or sets the displayed title for the list.
Public property Version Gets the version number of the list.
Public property Views Gets the collection of view objects that represents all the views of the list.
Public property WorkflowAssociations Gets the collection of workflow association objects that represents all the workflows that are associated with the list.
Public property WriteSecurity Gets or sets the Write security setting for the list.
Top

  NameDescription
Public method AddWorkflowAssociation Adds a workflow association to the list.
Public method BreakRoleInheritance Breaks the role assignment inheritance for the list and gives the current list its own copy of the role assignments.
Public method CheckPermissions Checks the permissions for the list and throws UnauthorizedAccessException if the current user does not have the specified set of rights.
Public method Delete Deletes the list.
Public method DoesUserHavePermissions(SPBasePermissions) Checks the permissions of the current user on the list.
Public method DoesUserHavePermissions(SPBasePermissions, Boolean) Checks the permissions of the list, and, optionally. checks the folder permissions.
Public method DoesUserHavePermissions(SPUser, SPBasePermissions) Checks the permissions of a specified user on the list.
Protected method EnsurePropsFresh Checks the properties of the list, and, if necessary, updates them to ensure that the most current settings are used.
Public method EnsureRssSettings Checks the RSS settings of the list, and, if necessary, updates them to ensure that the most current settings are used.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetChanges() Returns the first 1000 changes in the current change log for the list.
Public method GetChanges(SPChangeQuery) Returns a collection of changes from the change log filtered by the specified query.
Public method GetChanges(SPChangeToken) Returns a collection of changes starting from a particular point in the change log.
Public method GetChanges(SPChangeToken, SPChangeToken) Returns a collection of changes logged over a specified period of time.
Public method GetContentTypeIdByUrl Returns the content type identifier for the content type with the specified URL.
Public method GetDefaultViewForContentType Returns the default view of list data that is used by the specified content type.
Public method GetDirectChildContentType Returns the content type identifier for the content type that is the direct child of the specified content type.
Public method GetDistinctFieldValues 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.
Public method GetHashCode (Inherited from Object.)
Public method GetItemById Returns the list item with the specified integer ID.
Public method GetItemByUniqueId Returns the list item that is associated with the specified global unique identifier (GUID).
Public method GetItems(SPQuery) Returns a collection of items from the list based on the specified query.
Public method GetItems(SPView) Returns a collection of list items from the list based on the specified view.
Public method GetItems(SPQuery, String) Returns a collection of list items from the list based on the specified query and view.
Public method 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.
Public method GetType (Inherited from Object.)
Public method GetUncustomizedViewByBaseViewId Returns the view object that is associated with the specified base view identifier.
Public method GetUserEffectivePermissionInfo Gets an object with detailed information about the effective permissions that a specified user has on the list and the role assignments for this user at this scope.
Public method GetUserEffectivePermissions Gets the effective permissions that a specified user has on the list.
Public method GetView Returns a view of the list based on the specified GUID.
Public method IsContentTypeAllowed(SPContentType) Verifies that the list supports the specified content type.
Public method IsContentTypeAllowed(SPContentTypeId) Verifies that the list supports the specified content type.
Protected method MemberwiseClone (Inherited from Object.)
Public method Recycle Recycles the list and returns the list's globally unique identifier (GUID).
Public method RemoveWorkflowAssociation Removes the specified workflow association from the list.
Public method RenderAsHtml Returns a string representation of the specified query in HTML format.
Public method ResetRoleInheritance Removes the local role assignments and reverts to role assignments from the parent list.
Public method 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.
Public method Static member ServerTemplateCanReceiveEmail Returns a Boolean value that specifies whether the specified list template and Web site support receiving e-mail.
Protected method SetAttributesForPropertiesXML This member is reserved for internal use and is not intended to be used directly from your code.
Public method ToString Returns the title of the list. (Overrides Object.ToString().)
Public method Update() Updates the database with changes that are made to the list.
Public method Update(Boolean) Updates the database with changes that are made to the list, optionally including changes that result from data migration.
Public method UpdateWorkflowAssociation Updates the specified workflow assocation.
Public method WriteRssFeed(Stream) Writes the RSS feeds from the list to the specified document stream.
Public method WriteRssFeed(Stream, Int32) Writes the RSS feeds from the list that are associated with the specified meeting to the specified document stream.
Public method WriteRssFeed(Stream, Int32, SPView) Writes the RSS feeds from the list that are associated with the specified meeting and view to the specified document stream.
Top

  NameDescription
Protected field m_arrListProps This member is reserved for internal use and is not intended to be used directly from your code.
Protected field m_iRow This member is reserved for internal use and is not intended to be used directly from your code.
Protected field m_ListAttributesDict This member is reserved for internal use and is not intended to be used directly from your code.
Protected field m_Lists This member is reserved for internal use and is not intended to be used directly from your code.
Protected field m_Permissions This member is reserved for internal use and is not intended to be used directly from your code.
Top

Community Additions

ADD
Show:
© 2014 Microsoft