This documentation is archived and is not being maintained.

SPWeb Methods

Windows SharePoint Services 3

The SPWeb type exposes the following members.

  NameDescription
Public method AllowAllWebTemplates Resets the available Web templates on the Web site to the complete set of Web templates.
Public method ApplyTheme Applies a theme to a Web site.
Public method ApplyWebTemplate(String) Applies the specified site definition or site template to the Web site that has no template applied to it.
Public method ApplyWebTemplate(SPWebTemplate) Applies the specified site definition object or site template object to the Web site that has no template applied to it.
Public method BreakRoleInheritance Breaks inheritance of role assignments from the parent Web site.
Public method BypassUseRemoteApis Accesses the Web site by bypassing the SOAP, WebDAV and Microsoft Office SharePoint Designer 2007 interfaces.
Public method CheckPermissions Checks the permissions for the Web site and raises an Access Denied error if the permissions fail.
Public method Close Closes the Web site at the end of a request and releases resources.
Public method CreateDefaultAssociatedGroups Creates the default security groups that are associated with a site.
Public method CustomizeCss Customizes the specified style sheet for the Web site.
Public method Delete Deletes the Web site.
Public method Dispose Releases all unmanaged resources that are used by the Web site object.
Public method DoesUserHavePermissions(SPBasePermissions) Checks permissions of the current user for a specified set of rights and returns a Boolean value.
Public method DoesUserHavePermissions(String, SPBasePermissions) Checks permissions of the specified user for a specified set of rights and returns a Boolean value.
Public method EnsureUser Checks whether the specified login name belongs to a valid user of the Web site, and if the login name does not already exist, adds it to the Web site.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetAvailableCrossLanguageWebTemplates Returns the collection of available cross-language Web templates.
Public method GetAvailableWebTemplates(UInt32) Returns the Web templates that are available for creating subsites beneath the specified subsite, based on the specified locale identifier.
Public method GetAvailableWebTemplates(UInt32, Boolean) Returns the site templates that are available for creating subsites beneath the Web site, based on the specified locale identifier; also returns a Boolean value that specifies whether language neutral site templates should also be returned.
Public method GetCatalog Returns the list template gallery, site template gallery, or Web Part gallery for the Web site.
Public method GetChanges() Returns the first 1000 changes listed in the current change log for the Web site.
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 GetDocDiscussions Returns the collection of document discussion objects for the specified directory in the site.
Public method GetFieldLocalizations Returns the collection of localizations for the Web site for the specified culture.
Public method GetFile(Guid) Returns the file object with the specified GUID.
Public method GetFile(String) Returns the file object located at the specified URL.
Public method GetFileAsString Returns the contents of the file object located at the specified URL as a string.
Public method GetFileOrFolderObject Returns a file or folder on the Web site with the specified URL.
Public method GetFilePersonalizationInformation Returns the file level of a specified document as output parameters and also returns a value that specifies whether the document has personalized Web Parts.
Public method GetFolder(Guid) Returns the folder object with the specified GUID.
Public method GetFolder(String) Returns the folder object that is located at the specified URL.
Public method GetHashCode (Inherited from Object.)
Public method GetLimitedWebPartManager Returns the limited Web Part Manager for the specified Web Part page and view.
Public method GetList Returns the list that is associated with the specified server-relative URL.
Public method GetListFromUrl Returns the list that is associated with the first Web Part on the specified Web Part page. Beginning in Windows SharePoint Services 3.0, use the GetListFromWebPartPageUrl method instead of the GetListUrl method.
Public method GetListFromWebPartPageUrl Returns the list that is associated with the first Web Part on the specified Web Part page.
Public method GetListItem Returns the list item that is associated with the specified server-relative URL.
Public method GetListsOfType Returns a collection of list objects of the specified type from the Web site.
Public method GetObject Returns a file, folder, or list item that is associated with the specified URL.
Public method GetRecycleBinItems Returns a collection of recycle bin items that are based on the specified query.
Public method GetSiteData Performs a query for list items across multiple lists, which can be located in multiple Web sites in the same Web site collection.
Public method GetSubwebsForCurrentUser() Returns the collection of subsites beneath the current site of which the current user is a member.
Public method GetSubwebsForCurrentUser(Int32) Returns the collection of subsites beneath the current Web site of which the current user is a member based on the specified site definition.
Public method GetSubwebsForCurrentUser(Int32, Int16) Returns the collection of subsites beneath the current Web site in which the current user is a member, based on the specified site definition and configuration.
Public method GetType (Inherited from Object.)
Public method GetUsageData(SPUsageReportType, SPUsagePeriodType) Returns a table that contains information about the usage of a Web site, based on the specified report type and time interval.
Public method GetUsageData(SPUsageReportType, SPUsagePeriodType, Int32, DateTime) Returns a table that contains information about the usage of a Web site based on the specified report type, time interval, number of columns to display, and last day to display.
Public method GetUserEffectivePermissionInfo Get effective permissions that the specified user has and the role assignments related to this user within this scope.
Public method GetUserEffectivePermissions Retrieves the effective permissions the specified user has within the current application scope.
Public method GetViewFromUrl Returns a view of a list within the site based on the specified URL.
Public method GetWebPartCollection Obsolete. Use the GetLimitedWebPartManager method of the SPFile class to return an SPLimitedWebPartManager object to manage Web Parts instead. (In Windows SharePoint Services 2.0 the GetWebPartCollection method returned the collection of Web Parts on the page at the specified URL.)
Public method InsertAlertEvent(Guid, String, Int32, SPReusableAcl) Inserts an event in the events table for the specified custom prematching GUID, event data, event type, and reusable access control list (ACL).
Public method InsertAlertEvent(Guid, String, Int32, []) Inserts an event in the events table for the specified custom prematching GUID, event data, event type, and access control list (ACL).
Public method IsCurrentUserMemberOfGroup Returns a Boolean value that specifies whether the current user is a member of the specified group.
Protected method MemberwiseClone (Inherited from Object.)
Public method Static member OriginalBaseUrl Returns the base URL for the current request.
Public method ProcessBatchData Processes the specified batch string of commands for sending multiple requests to the server per transaction.
Public method RecalculateWebFineGrainedPermissions Recalculates whether the Web site contains a list or list item that has unique permissions, and updates the value of the AllowAutomaticASPXPageIndexing property.
Public method RemoveExternalSecurityProvider Removes the external security provider for the Web site.
Public method ResetRoleInheritance Resets the role inheritance for the Web site.
Public method RevertAllDocumentContentStreams Restores all files within the Web site to their original uncustomized state so that their logic becomes cached in memory (also known as "ghosted") rather than stored within the database.
Public method RevertCss Reverts style sheet customization of a file to the default style sheet.
Public method SaveAsTemplate Saves the Web site as a site template.
Public method SearchDocuments(String) Obsolete. For Search, use the Execute method of the Microsoft.SharePoint.Search.Query.KeywordQuery class or the Microsoft.SharePoint.Search.Query.FullTextSqlQuery class instead. (In Windows SharePoint Services 2.0, the SearchDocuments method searched documents in the Web site for the specified string.)
Public method SearchDocuments(String, UInt32, SPSearchResultCollectionPosition) Obsolete. For Search, use the Execute method of the Microsoft.SharePoint.Search.Query.KeywordQuery class or the Microsoft.SharePoint.Search.Query.FullTextSqlQuery class instead. (In Windows SharePoint Services 2.0, the SearchDocuments method searched documents in the Web site for the specified string based on the specified row limit and page position for the return set.)
Public method SearchListItems(String) Searches list data in the Web site for the specified string.
Public method SearchListItems(String, UInt32, SPSearchResultCollectionPosition) Searches list data in the Web site for the specified string, based on the specified row limit and page position for the return set.
Public method SetAvailableCrossLanguageWebTemplates Specifies a set of language-neutral Web templates that are available for creating subsites below the Web site, regardless of locale.
Public method SetAvailableWebTemplates Specifies the Web templates that are available for creating subsites below the Web site for the specified locale.
Public method ToString Returns the title of the Web site. (Overrides Object.ToString().)
Public method Update Updates the database with changes that are made to the Web site.
Public method ValidateFormDigest Validates the form digest control that is used in the current request.
Top
Show: