Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

SPList members

Represents a list on a Microsoft SharePoint Foundation Web site.

The SPList type exposes the following members.

  Name Description
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 a full list of role definitions on the object to which the current user belongs on this scope. (Inherited from SPSecurableObject.)
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 BrowserFileHandling Indicates the list file handling mode.
Public property CalculationOptions Indicates options for how calculated field formulas, list data validation formulas, and default value formulas are evaluated for the list.
Public property CanReceiveEmail Gets a Boolean value specifying whether the list can receive e-mail.
Public property ClientFormListData Returns a dictionary containing list properties used in CSR Forms
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 DataSource Gets the data source for a list that has an external data source.
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 DefaultDisplayFormUrl Gets or sets the URL to the default form for displaying list items.
Public property DefaultEditFormUrl Gets or sets the URL to the default form for editing list items.
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 DefaultItemOpenUseListSetting This property indicates whether to use the List setting or the server-wide setting for DefaultItemOpen (BrowserEnabledDocuments setting) in the Web application.
Public property DefaultNewFormUrl Gets or sets the URL to the default form for creating new list items.
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 DescriptionResource Gets an SPUserResource object that represents the translations for the description of the list.
Public property Direction Gets or sets the direction of the reading order for the list.
Public property DisableGridEditing Property for assigning or retrieving grid editing on 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. (Overrides SPSecurableObject.EffectiveBasePermissions.)
Public property EffectiveBasePermissionsForUI Gets the effective base permissions for the current user, as they should be displayed in UI. This will only differ from EffectiveBasePermissions if ReadOnlyUI is set to true, and in all cases will be a subset of EffectiveBasePermissions. To put it another way, EffectiveBasePermissionsForUI will always be as or more restrictive than EffectiveBasePermissions.
Public property EffectiveFolderPermissions Within an HTTP context, gets the effective base permissions for folders in the list.
Public property EffectiveFolderPermissionsForUI get effective base permissions for UI for current user on the specified folder in a list. This will only differ from EffectiveFolderPermissions if ReadOnlyUI is set to true, and in all cases will be a subset of EffectiveFolderPermissions. To put it another way, EffectiveFolderPermissionsForUI will always be as or more restrictive than EffectiveFolderPermissions.
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 Obsolete. 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 EnablePeopleSelector Enable user selector on event list.
Public property EnableResourceSelector Enables resource selector on an event 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 EnableThrottling Indicates whether throttling for this list is enabled or not.
Public property EnableVersioning Gets or sets a Boolean value that specifies whether versioning is enabled for the document library.
Public property EnforceDataValidation Gets or sets a value that indicates whether certain field properties are enforced when an item is added or updated.
Public property EntityTypeName The entity type name.
Public property EventReceivers Gets the collection of event receivers that have been registered for the list.
Public property EventSinkAssembly Obsolete. 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 Obsolete. 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 Obsolete. Gets or sets an arbitrary string for use by a Windows SharePoint Services 2.0 event handler for document library events.
Public property ExcludeFromOfflineClient Gets or sets a value that indicates whether the list should be downloaded to the client during offline synchronization.
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 FetchPropertyBagForListView Specifies whether we want to fetch propertybag info when we do listview client side rendering. If it's true, we'll send the property bad as part of the list schema JSON.
Public property FieldIndexes Gets the collection of field indexes defined on the list.
Public property Fields Gets the collection of field objects that represents all the fields in the list.
Public property FirstUniqueAncestor Obsolete. Use the FirstUniqueAncestorSecurableObject property instead. (Inherited from SPSecurableObject.)
Public property FirstUniqueAncestorSecurableObject Gets the object where role assignments for this list are defined. (Overrides SPSecurableObject.FirstUniqueAncestorSecurableObject.)
Public property Folders Gets the collection of folder items for the list.
Public property Followable Can a list be followed in an activity feed?
Public property ForceCheckout Gets or sets a Boolean value that specifies whether forced checkout is enabled for the document library.
Public property ForceDefaultContentType Specifies whether we want to return the default Document root content type.
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 HasExternalDataSource Gets a value that indicates whether the list has an external data source.
Public property HasUniqueRoleAssignments Indicates whether the object has unique role assignments or inherits its role assignments from a parent object. (Inherited from SPSecurableObject.)
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 IndexedRootFolderPropertyKeys Gets the set of property keys for root folder properties that need to be exposed through Site Data Web Service.
Public property InformationRightsManagementSettings settings of document library Information Rights Management (IRM)
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 IsApplicationList Indicates whether this list should be treated as a top level navigation object or not.
Public property IsPrivate Gets a Boolean value that indicates whether the document library is a private list with restricted permissions, such as for Solutions.
Public property IsSiteAssetsLibrary Indicates whether or not this list is designated as the default asset location for images or other files which the users uploads to their wiki pages.
Public property IsThrottled Gets a value that indicates whether the total number of items exceeds the upper limit set for the list.
Public property ItemCount Gets the number of items in the list, including folders.
Public property Items Gets an unfiltered collection of all items in the list.
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 ListItemEntityTypeFullName The entity type full name of the list item in the list.
Public property Lists Gets the parent collection of lists to which the list belongs.
Public property ListViewWebPartKey This is the Web part key for the list view Web part.
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 MobileDefaultDisplayFormUrl Retrieves the default mobile display form server relative URL for this list object.
Public property MobileDefaultEditFormUrl Retrieves the default mobile edit form server relative URL for this list object.
Public property MobileDefaultNewFormUrl Retrieves the default mobile new form server relative URL for this list object.
Public property MobileDefaultView Read-only property used to retrieve the mobile default view for the list.
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 NavigateForFormsPages Indicates whether to navigate for forms pages or use a modal dialog.
Public property NeedUpdateSiteClientTag A boolean value that determines whether to editing documents in this list should increment the ClientTag for the site. The tag is used to allow clients to cache JS/CSS/resources that are retrieved from the Content DB, including custom CSR templates
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 area 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 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 (CAML) schemas that specifies property values for the list.
Public property ReadOnlyUI A boolean value that indicates whether the UI for this list should be presented in a read-only fashion. This will not affect security nor will it actually prevent changes to the list from occurring - it only affects the way the UI is displayed.
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 RestrictUserUpdates A boolean value that indicates whether the this list is a restricted one or not The value can't be changed if there are existing items in the list
Public property ReusableAcl Gets an opaque object that represents the raw access control list (ACL) information for the list. (Overrides SPSecurableObject.ReusableAcl.)
Public property RoleAssignments Gets the role assignments for this securable object. (Inherited from SPSecurableObject.)
Public property RootFolder Gets the folder that contains all the files that are used in working with the list.
Public property RootWebOnly Property that indicates whether the option to allow deployment to root Webs only.
Public property SchemaXml Gets the schema in Collaborative Application Markup Language (CAML) schemas that defines the list.
Public property SchemaXmlInCurrentUICulture Read-only property used to retrieve the current UI culture XML schema.
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 SmsAlertTemplate Gets or sets the template used by the list for Short Message Service (SMS) alerts.
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 TitleResource Gets an SPUserResource object that represents the translations for the title of the list.
Public property UseFormsForDisplay Indicates whether forms should be considered for display context or not.
Public property UserCustomActions Gets the collection of user custom actions defined on the list.
Public property UserResources Gets the collection of user-defined localized resources scoped to the list.
Public property ValidationFormula Gets or sets a formula that is evaluated each time that a list item is added or updated.
Public property ValidationMessage Gets or sets the message that is displayed when validation fails for a list item.
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
  Name Description
Public method AddItem() Creates a list item in the root folder of the list.
Public method AddItem(String, SPFileSystemObjectType) Creates a list item of a specified type in the specified folder in the list.
Public method AddItem(String, SPFileSystemObjectType, String) Creates a list item of a specified type with a specified file name in the specified folder in the list.
Public method AddWorkflowAssociation Obsolete. Adds a workflow association to the list.
Public method AppendDataTable Appends the results returned by a query to an existing data table.
Public method BreakRoleInheritance(Boolean, Boolean) Creates unique role assignments for the list from the parent, optionally copies roles assignments from the parent, and optionally clears unique role assignments from descendants. (Overrides SPSecurableObject.BreakRoleInheritance(Boolean, Boolean).)
Public method BreakRoleInheritance(Boolean) Creates unique role assignments for the object and optionally copies role assignments from the parent. (Inherited from SPSecurableObject.)
Public method CheckPermissions Checks whether the current user has the specified set of permissions for the list and throws an exception if the user does not have them. (Overrides SPSecurableObject.CheckPermissions(SPBasePermissions).)
Public method Delete Deletes the list.
Public method DoesUserHavePermissions(SPBasePermissions, Boolean) Indicates whether the current user has a specified set of permissions on the list and optionally checks permissions on the current folder.
Public method DoesUserHavePermissions(SPUser, SPBasePermissions) Indicates whether the specified user has the specified set of permissions on the list.
Public method DoesUserHavePermissions(SPBasePermissions) Indicates whether the current user has a specified set of permissions. (Inherited from SPSecurableObject.)
Public method DoesUserHavePermissionsForUI(SPBasePermissions)
Public method DoesUserHavePermissionsForUI(SPBasePermissions, Boolean) Checks the permissions for a given set of rights, as they should be displayed in the UI, and returns a Boolean. Optionally checks for permissions on a folder. This will only differ from DoesUserHavePermissions if ReadOnlyUI is set to true, and will always be as or more restrictive than DoesUserHavePermissions.
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 Ensures that the RSS settings of the list are current.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetChanges() Returns the default number of changes from the current change log for the list.
Public method GetChanges(SPChangeQuery) Gets the changes to the list from the change log as 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 (ID) for the content type with the specified URL.
Public method GetDataTable Retrieves a data table that contains item data that satisfies a query.
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 (ID) for the content type that is the direct child of the specified content type.
Public method GetDistinctFieldValues Obsolete. 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 Gets the list item with the specified identifier (ID).
Public method GetItemByIdAllFields Returns the list item with the specified identifier (ID).
Public method GetItemByIdSelectedFields Gets the list item with the specified identifier (ID) and includes only the values for the specified fields.
Public method GetItemByUniqueId Gets the list item by GUID.
Public method GetItems(SPQuery) Gets a collection of items from the list based on the specified query.
Public method GetItems(SPQuery, String) Gets a collection of items from the list based on the specified query and view.
Public method GetItems(SPView) Returns a collection of items from the list based on the specified view.
Public method GetItems([]) Returns a collection of items from the list but includes only the specified field values.
Public method GetItemsWithUniquePermissions() Returns a collection of SPListItemInfo objects for items that have unique permissions.
Public method GetItemsWithUniquePermissions(Int32, Boolean) Returns a collection of SPListItemInfo objects for items that have unique permissions by specifying the maximum number of items to return and whether to return only folder information.
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 GetRelatedFields() Returns a collection of objects with information about a lookup field in another list that points to a field in this list.
Public method GetRelatedFields(SPRelationshipDeleteBehavior) Gets a collection of objects with information about a lookup field in another list that points to a field in this list, depending upon the specified deletion constraint.
Public method GetType (Inherited from Object.)
Public method GetUncustomizedViewByBaseViewId Gets the view object that is associated with the specified base view identifier (ID).
Public method GetUserEffectivePermissionInfo Gets detailed information about the effective permissions that a specified user has on the list and the role assignments for this user at this scope. (Overrides SPSecurableObject.GetUserEffectivePermissionInfo(String).)
Public method GetUserEffectivePermissions Gets the effective permissions that a specified user has on the list. (Overrides SPSecurableObject.GetUserEffectivePermissions(String).)
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 Obsolete. Removes the specified workflow association from the list.
Public method RenderAsHtml Gets the results of the specified query in HTML format.
Public method RenderListData(String) Returns the data for the specified query view.
Public method RenderListData(String, Guid) Returns the data for the specified query view.
Public method RenderListFormData
Public method ResetRoleInheritance Resets the role assignments of the list and all its descendant object to those of the list's parent object. (Overrides SPSecurableObject.ResetRoleInheritance().)
Public method SaveAsNewView First tries to find if the view already exists. Overwrite it if yes, add a new view if no. Then extract all the adhoc filter/sort info from the URL and build and update the view's xml Returns the url of the new/overwritten view.
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 Gets whether the specified list template and website support receiving email.
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(Boolean) Updates the database with changes that are made to the list, optionally including changes that result from data migration.
Public method Update() Updates the database with changes that are made to the list.
Public method UpdateWorkflowAssociation Obsolete. Updates the specified workflow association.
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 that are associated with the specified meeting to the specified document stream.
Public method WriteRssFeed(Stream, Int32, SPView) Writes the RSS feeds that are associated with the specified meeting and view to the specified document stream.
Top
  Name Description
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. All rights reserved.