Export (0) Print
Expand All

SPWeb Members

Windows SharePoint Services 3

Represents a Windows SharePoint Services Web site.

The SPWeb type exposes the following members.

  NameDescription
Public property Alerts Gets the collection of alerts for the site or subsite.
Public property AllowAnonymousAccess Gets a Boolean value that indicates whether anonymous access is allowed for the Web site.
Public property AllowAutomaticASPXPageIndexing Gets or sets a Boolean value that specifies whether the .aspx page within the Web site should be indexed by the search engine.
Public property AllowRssFeeds Gets a Boolean value that specifies whether the Web site allows RSS feeds.
Public property AllowUnsafeUpdates Gets or sets a Boolean value that specifies whether to allow updates to the database as a result of a GET request or without requiring a security validation.
Public property AllProperties Gets a hash table that contains metadata for the Web site.
Public property AllRolesForCurrentUser Gets the collection of role definitions for the roles to which the current user is assigned.
Public property AllUsers Gets the collection of user objects that represents all users who are either members of the site or who have browsed to the site as authenticated members of a domain group in the site.
Public property AllWebTemplatesAllowed Gets a Boolean value that indicates whether the available Web templates that are returned by the GetAvailableWebTemplates() method comprise the complete set of templates.
Public property AlternateCssUrl Gets or sets the URL for an alternate cascading style sheet (CSS) to use in the Web site.
Public property AlternateHeader Gets or sets the URL for an alternate .aspx page that will be used to render the top navigation area in Windows SharePoint Services pages.
Public property AnonymousPermMask64 Gets the base permissions for anonymous users of the Web site.
Public property AnonymousState Gets or sets the level of access for anonymous users on the Web site.
Public property ASPXPageIndexed Gets a Boolean value that specifies whether the .aspx pages of the Web site are automatically indexed.
Public property ASPXPageIndexMode Gets or sets the .aspx page indexing that is used by the Web site.
Public property AssociatedGroups Gets a list of the groups that are associated with the Web site.
Public property AssociatedMemberGroup Gets the users who have been given contribute permissions to the Web site.
Public property AssociatedOwnerGroup Gets or sets the associated owner groups of the Web site.
Public property AssociatedVisitorGroup Gets or sets the associated visitor group of the Web site.
Public property Audit Gets the audit log that is associated with the Web site.
Public property AuthenticationMode Infrastructure.
Public property Author Gets a user object that represents the user who created the Web site.
Public property AvailableContentTypes Gets the collection of all content types that apply to the current scope, including those of the current Web site, as well as any parent Web sites.
Public property AvailableFields Gets the collection of the available fields of the Web site.
Public property CacheAllSchema Gets or sets a Boolean value that specifies whether caching of all schemas on the Web site is enabled.
Public property Configuration Gets either the identifier (ID) of the site definition configuration that was used to create the site, or the ID of the site definition configuration from which the site template that was used to create the site was derived.
Public property ContentTypes Gets the collection of content types for the Web site.
Public property Created Gets a date and time value that indicates when the site was created.
Public property CurrencyLocaleID Gets the locale identifier (ID) that is used for currency in the Web site.
Public property CurrentChangeToken Gets the change token that is used when the next change is logged to the Web site.
Public property CurrentUser Gets the current user of the site.
Public property CustomMasterUrl Gets or sets the URL for a custom master page file to apply to the Web site.
Public property DataRetrievalServicesSettings Gets an object that represents the data retrieval service settings for the deployment of Windows SharePoint Services.
Public property Description Gets or sets the description for the site.
Public property DocTemplates Gets the collection of document templates that are used on the site.
Public property EffectiveBasePermissions Gets the effective base permissions that are assigned to the current user.
Public property EffectivePresenceEnabled Gets a Boolean value that indicates whether effective presence information is enabled on the site.
Public property EmailInsertsEnabled Obsolete. Gets a Boolean value that indicates whether document libraries on the virtual server can accept e-mail attachments from public folders.
Public property EventHandlersEnabled Gets a Boolean value that indicates whether Windows SharePoint Services 2.0 event handlers can be used on the site.
Public property EventReceivers Gets the collection of event receiver definitions that are currently available on the Web site.
Public property ExecuteUrl Gets the URL that is called after the site definition for a business solutions site is instantiated.
Public property Exists Gets a Boolean value that indicates whether the Web site exists.
Public property ExternalSecurityProviderSetting Gets the settings that are used by an external security provider for the site.
Public property Features Gets the collection of Features that are currently activated in the Web site.
Public property Fields Gets the collection of field objects that represents all the fields in the Web site.
Public property FieldTypeDefinitionCollection Gets the collection of SPFieldTypeDefinition objects that represents type definition information for the fields of the Web site.
Public property Files Gets the collection of all files in the root directory of the Web site.
Public property FirstUniqueAncestor Gets the first ancestor Web site with unique permissions and where the access control list (ACL) for the current site is defined.
Public property FirstUniqueAncestorWeb Gets the first parent Web site that has unique permissions.
Public property FirstUniqueRoleDefinitionWeb Gets the Web site where the role definitions for the current site were defined.
Public property Folders Gets the collection of all first-level folders in the Web site.
Public property Groups Gets the collection of cross-site groups for the site.
Public property HasExternalSecurityProvider Gets a Boolean value that indicates whether the site uses an external security provider.
Public property HasUniquePerm Obsolete. Gets or sets a Boolean value that specifies whether the site has unique permissions.
Public property HasUniqueRoleAssignments Gets a Boolean value that indicates whether the role assignments are uniquely defined for this Web site or inherited from a parent Web site.
Public property HasUniqueRoleDefinitions Gets a Boolean value that indicates whether the role definitions are uniquely defined for this Web site or inherited from a parent Web site.
Public property ID Gets the GUID for the site.
Public property IncludeSupportingFolders Gets or sets a Boolean value that specifies whether supporting folders for files or folders in the site are included in enumerations of files or folders.
Public property IsADAccountCreationMode Gets a Boolean value that indicates whether user accounts are automatically created in Active Directory Domain Services (AD DS) when users are invited to the Web site.
Public property IsADEmailEnabled Gets a Boolean value that indicates whether e-mail for Active Directory Domain Services (AD DS)is enabled on the site.
Public property IsRootWeb Gets a Boolean value that indicates whether the site is the top-level Web site of the site collection.
Public property Language Gets the locale identifier for the language that is used on the site.
Public property LastItemModifiedDate Gets the date and time that an item was last modified in the site.
Public property Lists Gets the collection of all lists that are contained in the Web site.
Public property ListTemplates Gets the collection of all list definitions and list templates that are available for creating lists on the Web site.
Public property Locale Gets or sets the locale for the Web site.
Public property MasterUrl Gets or sets the URL of the master page that is used for the Web site.
Public property Modules Gets the collection of modules that are used on the Web site.
Public property Name Gets or sets the name of the Web site.
Public property Navigation Gets a navigation object that represents navigation on the Web site, including the Quick Launch area and the top navigation bar.
Public property NoCrawl Gets or sets a Boolean value that specifies whether searching is enabled for the Web site.
Public property ParentWeb Gets the parent Web site of the specified Web site.
Public property ParentWebId Gets the identifier (ID) of the parent Web site for the site.
Public property ParserEnabled Gets or sets a Boolean value that specifies whether parsing is enabled for the Web site.
Public property Permissions Obsolete. Gets the collection of permissions for the Web site.
Public property PortalMember Gets a Boolean value that indicates whether the Web site is associated with a portal site.
Public property PortalName Gets the name of a portal site that is associated with the site.
Public property PortalSubscriptionUrl Gets the URL that is used for alerts within a portal.
Public property PortalUrl Gets the URL to a portal site that is associated with the site.
Public property PresenceEnabled Gets or sets a Boolean value that specifies whether inline presence information is enabled on the Web site.
Public property Properties Gets property settings for the site, such as the version of Windows SharePoint Services and the language locale. Instead use the new AllProperties property to return the settings for a Web site, because Properties returns only a subset of these settings.
Public property Provisioned Gets a Boolean value that indicates whether the Web site has been provisioned.
Public property PublicFolderRootUrl Gets the URL of the public folder that is used for e-mail attachments in document libraries.
Public property QuickLaunchEnabled Gets or sets a Boolean value that specifies whether the Quick Launch area is enabled on the Web site.
Public property RecycleBin Gets the recycle bin of the Web site.
Public property RegionalSettings Gets the regional settings that are currently implemented on the Web site.
Public property RequestAccessEmail Gets or sets the e-mail address to which requests for access are sent.
Public property RequestAccessEnabled Gets a Boolean value that indicates whether request for access to the Web site is enabled.
Public property ReusableAcl Gets the reusable access control list (ACL) for the Web site.
Public property RoleAssignments Gets the collection of role assignments for the Web site.
Public property RoleDefinitions Gets the collection of role definitions for the Web site.
Public property Roles Obsolete. Use the RoleDefinitions property to get the collection of role definitions for a Web site. In Windows SharePoint Services 2.0, the Roles property was used to get the collection of site groups on the Web site.
Public property RootFolder Gets the root folder for the Web site.
Public property ServerRelativeUrl Gets or sets the server-relative URL for the Web site.
Public property Site Gets the parent site collection for the Web site.
Public property SiteAdministrators Gets the collection of the Web site administrators.
Public property SiteGroups Gets the collection of cross-site groups for the site collection.
Public property SiteLogoDescription Gets or sets the description of the Web site logo.
Public property SiteLogoUrl Gets or sets the absolute URL of the Web site logo.
Public property SiteUserInfoList Gets the UserInfo list of the site collection that contains the Web site.
Public property SiteUsers Gets the collection of all users that belong to the site collection.
Public property SyndicationEnabled Gets or sets a Boolean value that specifies whether syndication is enabled in the Web site.
Public property Theme Gets the name of the theme that is applied to the Web site.
Public property ThemeCssUrl Gets the URL for the cascading style sheets file that is used in the theme for the Web site.
Public property Title Gets or sets the title for the Web site.
Public property TreeViewEnabled Gets or sets a Boolean value that specifies whether the Windows SharePoint Services TreeView is enabled in the left navigational area of Web site pages.
Public property Url Gets the absolute URL for the Web site.
Public property UserIsSiteAdmin Gets a Boolean value that indicates whether the user has administrative rights on the Web site, including ManageSubwebs, ManagePermissions, and ManageWeb permissions.
Public property UserIsWebAdmin Gets a Boolean value that indicates whether the user is a member of the Administrator site group for the site.
Public property Users Gets the collection of user objects that are explicitly assigned permissions in the Web site.
Public property ViewStyles Gets the collection of view styles for the Web site.
Public property Webs Gets a Web site collection object that represents all Web sites immediately beneath the Web site, excluding children of those Web sites.
Public property WebTemplate Gets the name of the site definition that was used to create the site, or gets the name of the site definition from which the site template that was used to create the site is derived.
Public property WebTemplateId Gets the identifier (ID) of the site definition that was used to create the site or the ID of the site definition from which the site template that was used to create the site is derived.
Public property WorkflowTemplates Gets the collection of workflow templates of the Web site.
Top

  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

Community Additions

ADD
Show:
© 2014 Microsoft