This documentation is archived and is not being maintained.

Microsoft.SharePoint Namespace

SharePoint 2003

The Microsoft.SharePoint namespace provides types and members that can be used for working with a SharePoint site and its subsites or lists. Its major classes include SPSite, a top-level class that represents a SharePoint site and provides access to its collection of subsites and templates; SPWeb, which represents a Web site and provides access to all its lists, files, folders, Web Parts, and other objects; and SPList, which represents a list and opens access to its fields, views, and other properties.

Classes

The following table shows the classes of the Microsoft.SharePoint namespace and a brief description of each.

Name Description
SPAlert Represents an alert, which generates periodic e-mail notifications sent to a user about the list, list item, document, or document library to which the alert applies.
SPAlertCollection Represents a collection of SPAlert objects.
SPAttachmentCollection Represents the collection of attachments for a list item.
SPBaseCollection Provides the base functionality for collections in the Microsoft.SharePoint and Microsoft.SharePoint.Administration namespaces.
SPDataRetrievalServicesSettings Represents the data retrieval service settings that are used in a virtual server running Microsoft Windows SharePoint Services.
SPDocDiscussion Represents all the discussions associated with a single document that has been discussed in a document library.
SPDocDiscussionCollection Represents the collection of SPDocDiscussion objects associated with documents in a specific document library.
SPDocTemplate Represents a document template used in a document library.
SPDocTemplateCollection Represents a collection of document templates.
SPDocumentLibrary Represents a document library in Microsoft Windows SharePoint Services.
SPException Represents an exception in Microsoft Windows SharePoint Services.
SPField Represents a field in a list on a SharePoint Web site.
SPFieldCalculated Represents a calculated field in a list.
SPFieldChoice Represents a choice field.
SPFieldCollection Represents a collection of SPField objects.
SPFieldCurrency Represents a field that contains currency values.
SPFieldDateTime Represents a field that contains date and time values.
SPFieldLookup Represents a lookup field.
SPFieldMultiChoice Represents a field that can contain multiple values.
SPFieldMultiLineText Represents a text field that can contain multiple lines.
SPFieldNumber Represents a field for numbers.
SPFieldRatingScale Represents a rating scale field used in surveys.
SPFieldText Represents a field that contains a single line of text.
SPFieldUrl Represents a field that contains URL values.
SPFieldUser Represents a user field.
SPFile Represents a file in a SharePoint Web site that can be a Web Part Page, an item in a document library, or a file in a folder.
SPFileCollection Represents a collection of SPFile objects.
SPFileVersion Represents a version of an SPFile object.
SPFileVersionCollection Represents a collection of SPFileVersion objects.
SPFolder Represents a folder on a SharePoint Web site.
SPFolderCollection Represents a collection of SPFolder objects.
SPForm Represents a form creating, displaying, or editing a list item in a list.
SPFormCollection Represents a collection of SPForm objects.
SPGroup Represents a cross-site group on a SharePoint Web site.
SPGroupCollection Represents a collection of SPGroup objects.
SPIssueList Represents an Issues list.
SPLanguage Represents a natural language used within the context of Microsoft Windows SharePoint Services.
SPLanguageCollection Represents a collection of SPLanguage objects.
SPList Represents a list on a SharePoint Web site.
SPListCollection Represents a collection of SPList objects.
SPListEvent Represents an event that occurs within a document library.
SPListItem Represents an item, or row, in a list.
SPListItemCollection Represents a collection of SPListItem objects.
SPListItemCollectionPosition Supports paging through data sets, storing the state that is needed to get the next page of data for a specific view of a list.
SPListTemplate Represents a list definition or a list template, which defines the fields and views for a list. List definitions are contained in files in the Local_Drive:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\60 directory, but list templates are created through the user interface or through the object model when a list is saved as a template.
SPListTemplateCollection Represents a collection of SPListTemplate objects.
SPLocale Represents regional settings for a locale that is represented on the site.
SPLocaleCollection Represents a collection of SPLocale objects.
SPMember Is the base class for the SPUser, SPRole, and SPGroup classes.
SPModerationInformation Provides information about the content approval status for an item in a list or a document library.
SPModule Represents the collection of files and views that are used in a site template.
SPModuleCollection Represents a collection of SPModule objects.
SPModule.SPModulePropertyBag Represents metadata for a module.
SPPermission Represents the permission assigned to a user, site group, or cross-site group for a list or a site.
SPPermissionCollection Represents a collection of SPPermission objects.
SPPictureLibrary Represents a document library that contains pictures.
SPQuery Represents a query in a list view.
SPRegionalSettings Represents regional settings that are used on the server running Microsoft Windows SharePoint Services.
SPRole Represents a site group in Microsoft Windows SharePoint Services.
SPRoleCollection Represents a collection of SPRole objects.
SPSearchResult Represents the item returned as a result of a search performed on a list, document library, or site.
SPSearchResultCollection Represents a collection of SPSearchResult objects.
SPSearchResultCollectionPosition Supports paging through the results of a search and storing the state that is required to get the next page of data.
SPSite Represents a collection of sites on a virtual server, including a top-level site and all its subsites. Each SPSite object, or site collection, is represented within an SPSiteCollection object that consists of the collection of all site collections on the virtual server.
SPTimeZone Represents the time zone setting that is implemented on a SharePoint Web site.
SPTimeZoneCollection Represents a collection of SPTimeZone objects.
SPUser Represents a user in Microsoft Windows SharePoint Services.
SPUserCollection Represents a collection of SPUser objects.
SPUserStorage Maintains information about the user of a Web Part Page and the amount of space in bytes that the user is consuming.
SPUserStorageCollection Represents a collection of SPUserStorage objects used to maintain storage information for all users of a Web Part Page.
SPView Represents a view of the data contained in a list on a SharePoint site.
SPViewCollection Represents a collection of SPView objects.
SPViewFieldCollection Represents the collection of fields returned in a view.
SPViewStyle Represents a style for a view.
SPViewStyleCollection Represents a collection of SPViewStyle objects.
SPWeb Represents a SharePoint site.
SPWebCollection Represents a collection of SPWeb objects.
SPWebPartCollection Represents a collection of Web Parts.
SPWebTemplate Represents a site definition or a site template that is used to instantiate a SharePoint site. Site definitions are contained in files within Local_Drive:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\60, while site templates are created through the user interface or through the object model when a site is saved as a template.
SPWebTemplateCollection Represents a collection of SPWebTemplate objects.

Enumerations

The following table shows the enumerations of the Microsoft.SharePoint namespace and a brief description of each.

Name Description
PAGETYPE Specifies the type of a form.
SPAlertFrequency Specifies the time interval for sending an alert about changes to a specific list, list item, document library, or document.
SPAlertType Specifies the type of item that an alert applies to.
SPEventType Specifies the type of event for a list, list item, document, or document library to which an alert responds.
SPBaseType Specifies the base type for a list.
SPCalendarOrderType Specifies the order to use for day, month, and year in calendar dates.
SPCalendarType Specifies the calendar type.
SPChoiceFormatType Specifies how options for making selections in a choice field are displayed.
SPCurrencyFieldFormats Specifies the format to use in currency fields.
SPDateTimeFieldFormatType Specifies the format to use in displaying date and time fields.
SPFieldType Specifies a field type for a field.
SPFile.SPCheckOutStatus Specifies the check-out status for a file in a document library.
SPIssueList.ReportType Specifies the kind of report to use in displaying data from an Issues list.
SPListEventType Specifies the type of an event that occurs in a document library.
SPListTemplateType Specifies the type of a list definition or a list template.
SPModerationStatusType Specifies values for content approval status of items in lists and document libraries.
SPNumberFormatTypes Specifies the number of decimal places to use in number and currency fields.
SPObjectType Specifies the type of object, which can be a list or a site.
SPPermissionGroup Represents the permissions available for site groups on a Web site.
SPRights Specifies the rights that apply to users, site groups, and cross-site groups.
SPRoleType Specifies the type of site groups available for users and groups.
SPSite.StorageManagementSortedOn Specifies whether items on a page are sorted by size (increasing or decreasing) or by date (increasing or decreasing).
SPSite.StorageManagementSortOrder Specifies the direction in which items are sorted on a page.
SPSite.StorageManagementInformationType Specifies the kind of storage management data to display.
SPUrlFieldFormatType Specifies the format used for URL fields.
SPViewCollection.SPViewType Specifies the type of view to implement for a list.
SPViewScope Specifies the recursive scope of a view for a document library.
SPWebTemplate.TeamSiteConfiguration Specifies a configuration in the site definition for a site.
SPWebTemplate.WebTemplate Specifies the type of a site definition.
SPWeb.WebAnonymousState Specifies settings for anonymous access to a site.
WffRequestType Specifies the type of file dialog box or form for a document library.

Interfaces

The following table shows the interfaces of the Microsoft.SharePoint namespace and a brief description of each.

Name Description
IExternalSecurityWeb Provides methods that return custom information about the security used in Microsoft Windows SharePoint Services for use in indexing by a search crawler on a portal.
IFileDialogPostProcessor Provides a method for customizing the Web views used in file dialog boxes and forms of document libraries.
IListEventSink Defines the interface that a list event handler must implement to respond to events within a document library.

Structures

The following table shows the structures of the Microsoft.SharePoint namespace and a brief description of each.

Name Description
ExternalSecurityWebProperty Provides fields that contain custom information about security used in Microsoft Windows SharePoint Services.
SPSite.UsageInfo Provides fields used to access information regarding site collection usage.
SPSystemTime Provides properties used to define system date and time values.
SPTimeZoneInformation Provides fields used to define a time zone.
SPUserInfo Defines information about a user who is not currently registered in the content database.

Show: