SPDocumentLibrary Members
Include Protected Members
Include Inherited Members
Represents a document library in Microsoft SharePoint Foundation.
The SPDocumentLibrary type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AlertTemplate | Gets or sets the alert template that is used by the list. (Inherited from SPList.) |
|
AllowContentTypes | Returns true if the list supports content types. (Inherited from SPList.) |
|
AllowDeletion | Gets or sets a Boolean value specifying whether the list can be deleted. (Inherited from SPList.) |
|
AllowEveryoneViewItems | Gets or sets a Boolean value specifying whether everyone can view documents in the document library or attachments to items in the list. (Inherited from SPList.) |
|
AllowMultiResponses | Gets or sets a Boolean value specifying whether users are allowed to give multiple responses to the survey. (Inherited from SPList.) |
|
AllowRssFeeds | Gets a Boolean value that specifies whether the list allows RSS feeds. (Inherited from SPList.) |
|
AllRolesForCurrentUser | Gets a full list of role definitions on the object to which the current user belongs on this scope. (Inherited from SPSecurableObject.) |
|
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.) (Inherited from SPList.) |
|
AnonymousPermMask64 | Gets or sets the base permissions for anonymous users of the list. (Inherited from SPList.) |
|
Audit | Gets the audit log that is associated with the list. (Inherited from SPList.) |
|
Author | Gets an SPUser object that represents information about the user who created the list. (Inherited from SPList.) |
|
BaseTemplate | Gets the list definition type on which the list is based. (Inherited from SPList.) |
|
BaseType | Gets the base type for the list. (Inherited from SPList.) |
|
BrowserFileHandling | Indicates the list file handling mode. (Inherited from SPList.) |
|
CalculationOptions | Indicates options for how calculated field formulas, list data validation formulas, and default value formulas are evaluated for the list. (Inherited from SPList.) |
|
CanReceiveEmail | Gets a Boolean value specifying whether the list can receive e-mail. (Inherited from SPList.) |
|
CheckedOutFiles | Gets the collection of files that are uploaded to the document library but are not checked in. |
|
ContentTypes | Gets the content types that are associated with the list. (Inherited from SPList.) |
|
ContentTypesEnabled | Gets or sets a Boolean value specifying whether content types are enabled for the list. (Inherited from SPList.) |
|
Created | Gets the creation date and time for the list. (Inherited from SPList.) |
|
CurrentChangeToken | Gets the change token that will be used in logging the next change to the list. (Inherited from SPList.) |
|
DataSource | Gets the data source for a list that has an external data source. (Inherited from SPList.) |
|
DefaultApprovalWorkflowId | Obsolete. Use the DefaultContentApprovalWorkflowId property instead. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
DefaultDisplayFormUrl | Gets or sets the URL to the default form for displaying list items. (Inherited from SPList.) |
|
DefaultEditFormUrl | Gets or sets the URL to the default form for editing list items. (Inherited from SPList.) |
|
DefaultItemOpen | Gets or sets a value that specifies whether to open list items in a client application or in the browser. (Inherited from SPList.) |
|
DefaultItemOpenUseListSetting | This property indicates whether to use the List setting or the server-wide setting for DefaultItemOpen (BrowserEnabledDocuments setting) in the Web application. (Inherited from SPList.) |
|
DefaultNewFormUrl | Gets or sets the URL to the default form for creating new list items. (Inherited from SPList.) |
|
DefaultView | Gets the default view for the list. (Inherited from SPList.) |
|
DefaultViewUrl | Gets the URL of the default view for the list. (Inherited from SPList.) |
|
Description | Gets or sets the description for the list. (Inherited from SPList.) |
|
DescriptionResource | Gets an SPUserResource object that represents the translations for the description of the list. (Inherited from SPList.) |
|
Direction | Gets or sets the direction of the reading order for the list. (Inherited from SPList.) |
|
DisableGridEditing | Property for assigning or retrieving grid editing on the list. (Inherited from SPList.) |
|
DocumentTemplateUrl | Gets or sets the URL of the document template for the library relative to the Web site that contains the document library. |
|
DraftVersionVisibility | Gets or sets a value that determines the type of user who can view minor versions of document drafts within the list. (Inherited from SPList.) |
|
EffectiveBasePermissions | Gets the effective base permissions of the current user for the list, including their group membership and policies. (Inherited from SPList.) |
|
EffectiveFolderPermissions | Within an HTTP context, gets the effective base permissions for folders in the list. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
EmailInsertsFolder | Obsolete. Gets or sets the path for the public folder that contains the e-mail items inserted in the document library. |
|
EnableAssignToEmail | Gets or sets a Boolean value specifying whether e-mail notification is enabled for the list. (Inherited from SPList.) |
|
EnableAttachments | Gets or sets a Boolean value that specifies whether attachments can be added to items in the list. (Inherited from SPList.) |
|
EnableDeployingList | Obsolete. Gets or sets a Boolean value specifying whether the list can be deployed. (Inherited from SPList.) |
|
EnableDeployWithDependentList | Gets or sets a Boolean value that specifies whether the list can be deployed with a dependent list. (Inherited from SPList.) |
|
EnableFolderCreation | Gets or sets a Boolean value that specifies whether folders can be created for the list. (Inherited from SPList.) |
|
EnableMinorVersions | Gets or sets a Boolean value that specifies whether minor versions are enabled when versioning is enabled for the document library. (Inherited from SPList.) |
|
EnableModeration | Gets or sets a Boolean value that specifies whether Content Approval is enabled for the list. (Inherited from SPList.) |
|
EnablePeopleSelector | Enable user selector on event list. (Inherited from SPList.) |
|
EnableResourceSelector | Enables resource selector on an event list. (Inherited from SPList.) |
|
EnableSchemaCaching | Gets or sets a Boolean value specifying whether schema caching is enabled for the list. (Inherited from SPList.) |
|
EnableSyndication | Gets or sets a Boolean value that specifies whether RSS syndication is enabled for the list. (Inherited from SPList.) |
|
EnableThrottling | Indicates whether throttling for this list is enabled or not. (Inherited from SPList.) |
|
EnableVersioning | Gets or sets a Boolean value that specifies whether versioning is enabled for the document library. (Inherited from SPList.) |
|
EnforceDataValidation | Gets or sets a value that indicates whether certain field properties are enforced when an item is added or updated. (Inherited from SPList.) |
|
EventReceivers | Gets the collection of event receivers that have been registered for the list. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
EventSinkData | Obsolete. Gets or sets an arbitrary string for use by a Windows SharePoint Services 2.0 event handler for document library events. (Inherited from SPList.) |
|
ExcludeFromOfflineClient | Gets or sets a value that indicates whether the list should be downloaded to the client during offline synchronization. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
FieldIndexes | Gets the collection of field indexes defined on the list. (Inherited from SPList.) |
|
Fields | Gets the collection of field objects that represents all the fields in the list. (Inherited from SPList.) |
|
FirstUniqueAncestor | Obsolete. Use the FirstUniqueAncestorSecurableObject property instead. (Inherited from SPSecurableObject.) |
|
FirstUniqueAncestorSecurableObject | Gets the object where role assignments for this list are defined. (Inherited from SPList.) |
|
Folders | Gets the collection of folder items for the list. (Inherited from SPList.) |
|
ForceCheckout | Gets or sets a Boolean value that specifies whether forced checkout is enabled for the document library. (Inherited from SPList.) |
|
Forms | Gets a collection of form objects that represent the forms that are used in creating, editing, or displaying items in the list. (Inherited from SPList.) |
|
HasExternalDataSource | Gets a value that indicates whether the list has an external data source. (Inherited from SPList.) |
|
HasUniqueRoleAssignments | Indicates whether the object has unique role assignments or inherits its role assignments from a parent object. (Inherited from SPSecurableObject.) |
|
Hidden | Gets or sets a Boolean value that specifies whether the list is hidden. (Inherited from SPList.) |
|
ID | Gets the GUID that identifies the list in the database. (Inherited from SPList.) |
|
ImageUrl | Gets the server-relative URL for the icon that represents the list. (Inherited from SPList.) |
|
IrmEnabled | Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) is enabled for the list. (Inherited from SPList.) |
|
IrmExpire | Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) expiration is enabled for the list. (Inherited from SPList.) |
|
IrmReject | Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) rejection is enabled for the list. (Inherited from SPList.) |
|
IsApplicationList | Indicates whether this list should be treated as a top level navigation object or not. (Inherited from SPList.) |
|
IsCatalog | Gets a Boolean value that indicates whether the document library is a gallery, such as for site templates, list templates, Web Parts, or Master Pages. |
|
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. (Inherited from SPList.) |
|
IsThrottled | Gets a value that indicates whether the total number of items exceeds the upper limit set for the list. (Inherited from SPList.) |
|
ItemCount | Gets the number of items in the list, including folders. (Inherited from SPList.) |
|
Items | Gets an unfiltered collection of all items in the list. (Inherited from SPList.) |
|
LastItemDeletedDate | Gets the date and time that an item in the list was last deleted. (Inherited from SPList.) |
|
LastItemModifiedDate | Gets the date and time that an item, field, or property of the list was last modified. (Inherited from SPList.) |
|
Lists | Gets the parent collection of lists to which the list belongs. (Inherited from SPList.) |
|
ListViewWebPartKey | This is the Web part key for the list view Web part. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
MobileDefaultDisplayFormUrl | Retrieves the default mobile display form server relative URL for this list object. (Inherited from SPList.) |
|
MobileDefaultEditFormUrl | Retrieves the default mobile edit form server relative URL for this list object. (Inherited from SPList.) |
|
MobileDefaultNewFormUrl | Retrieves the default mobile new form server relative URL for this list object. (Inherited from SPList.) |
|
MobileDefaultView | Read-only property used to retrieve the mobile default view for the list. (Inherited from SPList.) |
|
MobileDefaultViewUrl | Gets the URL of the default mobile view for the list. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
NavigateForFormsPages | Indicates whether to navigate for forms pages or use a modal dialog. (Inherited from SPList.) |
|
NoCrawl | Gets or sets a Boolean value specifying whether crawling is enabled for the list. (Inherited from SPList.) |
|
OnQuickLaunch | Gets or sets a Boolean value that specifies whether the list appears on the Quick Launch area of the home page. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
ParentWeb | Gets the parent Web site for the list. (Inherited from SPList.) |
|
ParentWebUrl | Gets the URL of the parent Web site for the list. (Inherited from SPList.) |
|
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.) (Inherited from SPList.) |
|
PropertiesXml | Gets a fragment in Collaborative Application Markup Language Core Schemas that specifies property values for the list. (Inherited from SPList.) |
|
ReadSecurity | Gets or sets the Read security setting for the list. (Inherited from SPList.) |
|
RequestAccessEnabled | Gets or sets a Boolean value that specifies whether the option to allow users to request access to the list is available. (Inherited from SPList.) |
|
RestrictedTemplateList | Gets a Boolean value that indicates whether access to the template list is restricted. (Inherited from SPList.) |
|
ReusableAcl | Gets an opaque object that represents the raw access control list (ACL) information for the list. (Inherited from SPList.) |
|
RoleAssignments | Gets the role assignments for this securable object. (Inherited from SPSecurableObject.) |
|
RootFolder | Gets the folder that contains all the files that are used in working with the list. (Inherited from SPList.) |
|
RootWebOnly | Property that indicates whether the option to allow deployment to root Webs only. (Inherited from SPList.) |
|
SchemaXml | Gets the schema in Collaborative Application Markup Language Core Schemas that defines the list. (Inherited from SPList.) |
|
SchemaXmlInCurrentUICulture | Read-only property used to retrieve the current UI culture XML schema. (Inherited from SPList.) |
|
SendToLocationName | Gets or sets a file name to use when copying an item in the list to another document library. (Inherited from SPList.) |
|
SendToLocationUrl | Gets or sets a URL to use when copying an item in the list to another document library. (Inherited from SPList.) |
|
ServerRelativeDocumentTemplateUrl | Gets the server-relative URL of the document template for the library. |
|
ServerTemplateCanCreateFolders | Gets a Boolean value that specifies whether server template folder creation is enabled for the list. (Inherited from SPList.) |
|
ShowUser | Gets or sets a Boolean value that specifies whether names of users are shown in the results of the survey. (Inherited from SPList.) |
|
SmsAlertTemplate | Gets or sets the template used by the list for Short Message Service (SMS) alerts. (Inherited from SPList.) |
|
TemplateFeatureId | Gets the globally unique identifier (GUID) of a template feature that is associated with the list. (Inherited from SPList.) |
|
ThumbnailsEnabled | Gets or sets a Boolean value to indicate whether thumbnail images will be extracted during document parsing. |
|
ThumbnailSize | Gets or sets the height and width of a thumbnail image in pixels in the image gallery. |
|
Title | Gets or sets the displayed title for the list. (Inherited from SPList.) |
|
TitleResource | Gets an SPUserResource object that represents the translations for the title of the list. (Inherited from SPList.) |
|
UseFormsForDisplay | Gets a value that indicates whether to use forms to display context. (Overrides SPList.UseFormsForDisplay.) |
|
UserCustomActions | Gets the collection of user custom actions defined on the list. (Inherited from SPList.) |
|
UserResources | Gets the collection of user-defined localized resources scoped to the list. (Inherited from SPList.) |
|
ValidationFormula | Gets or sets a formula that is evaluated each time that a list item is added or updated. (Inherited from SPList.) |
|
ValidationMessage | Gets or sets the message that is displayed when validation fails for a list item. (Inherited from SPList.) |
|
Version | Gets the version number of the list. (Inherited from SPList.) |
|
Views | Gets the collection of view objects that represents all the views of the list. (Inherited from SPList.) |
|
WebImageHeight | Gets or sets the height of a Web image in the document library. |
|
WebImageWidth | Gets or sets the width of a Web image in the document library. |
|
WorkflowAssociations | Gets the collection of workflow association objects that represents all the workflows that are associated with the list. (Inherited from SPList.) |
|
WriteSecurity | Gets or sets the Write security setting for the list. (Inherited from SPList.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AddItem() | Creates a list item in the root folder of the list. (Inherited from SPList.) |
|
AddItem(String, SPFileSystemObjectType) | Creates a list item of a specified type in the specified folder in the list. (Inherited from SPList.) |
|
AddItem(String, SPFileSystemObjectType, String) | Creates a list item of a specified type with a specified file name in the specified folder in the list. (Inherited from SPList.) |
|
AddWorkflowAssociation | Obsolete. Adds a workflow association to the list. (Inherited from SPList.) |
|
AppendDataTable | Appends the results returned by a query to an existing data table. (Inherited from SPList.) |
|
BreakRoleInheritance(Boolean) | Creates unique role assignments for the object and optionally copies role assignments from the parent. (Inherited from SPSecurableObject.) |
|
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. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
Delete | Deletes the list. (Inherited from SPList.) |
|
DoesUserHavePermissions(SPBasePermissions) | Indicates whether the current user has a specified set of permissions. (Inherited from SPSecurableObject.) |
|
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. (Inherited from SPList.) |
|
DoesUserHavePermissions(SPUser, SPBasePermissions) | Indicates whether the specified user has the specified set of permissions on the list. (Inherited from SPList.) |
.gif "Protected method") |
EnsurePropsFresh | Checks the properties of the list, and, if necessary, updates them to ensure that the most current settings are used. (Inherited from SPList.) |
|
EnsureRssSettings | Ensures that the RSS settings of the list are current. (Inherited from SPList.) |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
GetChanges() | Returns the default number of changes from the current change log for the list. (Inherited from SPList.) |
|
GetChanges(SPChangeQuery) | Gets the changes to the list from the change log as filtered by the specified query. (Inherited from SPList.) |
|
GetChanges(SPChangeToken) | Returns a collection of changes starting from a particular point in the change log. (Inherited from SPList.) |
|
GetChanges(SPChangeToken, SPChangeToken) | Returns a collection of changes logged over a specified period of time. (Inherited from SPList.) |
|
GetContentTypeIdByUrl | Returns the content type identifier (ID) for the content type with the specified URL. (Inherited from SPList.) |
|
GetDataTable | Retrieves a data table that contains item data that satisfies a query. (Inherited from SPList.) |
|
GetDefaultViewForContentType | Returns the default view of list data that is used by the specified content type. (Inherited from SPList.) |
|
GetDirectChildContentType | Returns the content type identifier (ID) for the content type that is the direct child of the specified content type. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
GetHashCode | (Inherited from Object.) |
|
GetItemById | Gets the list item with the specified identifier (ID). (Inherited from SPList.) |
|
GetItemByIdAllFields | Returns the list item with the specified identifier (ID). (Inherited from SPList.) |
|
GetItemByIdSelectedFields | Gets the list item with the specified identifier (ID) and includes only the values for the specified fields. (Inherited from SPList.) |
|
GetItemByUniqueId | Gets the list item by GUID. (Inherited from SPList.) |
|
GetItems([]) | Returns a collection of items from the list but includes only the specified field values. (Inherited from SPList.) |
|
GetItems(SPQuery) | Gets a collection of items from the list based on the specified query. (Inherited from SPList.) |
|
GetItems(SPView) | Returns a collection of items from the list based on the specified view. (Inherited from SPList.) |
|
GetItems(SPQuery, String) | Gets a collection of items from the list based on the specified query and view. (Inherited from SPList.) |
|
GetItemsInFolder | Returns a collection of items from the document library based on the specified view and folder. |
|
GetItemsWithUniquePermissions() | Returns a collection of SPListItemInfo objects for items that have unique permissions. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
GetRelatedFields() | Returns a collection of objects with information about a lookup field in another list that points to a field in this list. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
GetType | (Inherited from Object.) |
|
GetUncustomizedViewByBaseViewId | Gets the view object that is associated with the specified base view identifier (ID). (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
GetUserEffectivePermissions | Gets the effective permissions that a specified user has on the list. (Inherited from SPList.) |
|
GetView | Returns a view of the list based on the specified GUID. (Inherited from SPList.) |
|
IsContentTypeAllowed(SPContentType) | Verifies that the list supports the specified content type. (Inherited from SPList.) |
|
IsContentTypeAllowed(SPContentTypeId) | Verifies that the list supports the specified content type. (Inherited from SPList.) |
|
MemberwiseClone | (Inherited from Object.) |
|
Recycle | Recycles the list and returns the list's globally unique identifier (GUID). (Inherited from SPList.) |
|
RemoveWorkflowAssociation | Obsolete. Removes the specified workflow association from the list. (Inherited from SPList.) |
|
RenderAsHtml | Gets the results of the specified query in HTML format. (Inherited from SPList.) |
|
ResetRoleInheritance | Resets the role assignments to those of the parent object. (Inherited from SPList.) |
|
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. (Inherited from SPList.) |
|
SetAttributesForPropertiesXML | This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from SPList.) |
|
ToString | Returns the title of the list. (Inherited from SPList.) |
|
Update() | Updates the database with changes that are made to the list. (Inherited from SPList.) |
|
Update(Boolean) | Updates the database with changes that are made to the list, optionally including changes that result from data migration. (Inherited from SPList.) |
|
UpdateWorkflowAssociation | Obsolete. Updates the specified workflow association. (Inherited from SPList.) |
|
WriteRssFeed(Stream) | Writes the RSS feeds from the list to the specified document stream. (Inherited from SPList.) |
|
WriteRssFeed(Stream, Int32) | Writes the RSS feeds that are associated with the specified meeting to the specified document stream. (Inherited from SPList.) |
|
WriteRssFeed(Stream, Int32, SPView) | Writes the RSS feeds that are associated with the specified meeting and view to the specified document stream. (Inherited from SPList.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") |
m_arrListProps | This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from SPList.) |
|
m_iRow | This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from SPList.) |
|
m_ListAttributesDict | This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from SPList.) |
|
m_Lists | This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from SPList.) |
|
m_Permissions | This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from SPList.) |
Top