SPWeb Members

Include Protected Members
Include Inherited Members

Represents a SharePoint Foundation website.

The SPWeb type exposes the following members.

Properties

	Name	Description
	Alerts	Gets the collection of alerts for the site or subsite.
	AllowAnonymousAccess	Gets a Boolean value that indicates whether anonymous access is allowed for the website.
	AllowAutomaticASPXPageIndexing	Gets or sets a Boolean value that specifies whether the .aspx page within the website should be indexed by the search engine.
	AllowDesignerForCurrentUser	Gets a Boolean value that specifies whether the current user is allowed to use the designer for this website. The default value is false.
	AllowMasterPageEditingForCurrentUser	A Boolean value that specifies whether the current user is allowed to edit master pages.
	AllowRevertFromTemplateForCurrentUser	A Boolean value that specifies whether the current user is allowed to revert the site from the template.
	AllowRssFeeds	Gets a Boolean value that specifies whether the website allows RSS feeds.
	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.
	AllProperties	Gets a hash table that contains metadata for the website.
	AllRolesForCurrentUser	Gets a full list of role definitions on the object to which the current user belongs on this scope. (Inherited from SPSecurableObject.)
	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.
	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.
	AlternateCssUrl	Gets or sets the URL for an alternate cascading style sheet (CSS) to use in the website.
	AlternateHeader	Gets or sets the URL for an alternate .aspx page that will be used to render the top navigation area in SharePoint Foundation pages.
	AnonymousPermMask64	Gets or sets the base permissions for anonymous users of the website. (Read-only in sandboxed solutions.)
	AnonymousState	Gets or sets the level of access for anonymous users on the website.
	ASPXPageIndexed	Gets a Boolean value that specifies whether the .aspx pages of the website are automatically indexed.
	ASPXPageIndexMode	Gets or sets the .aspx page indexing that is used by the website.
	AssociatedGroups	Gets a list of the groups that are associated with the website.
	AssociatedMemberGroup	Gets the users who have been given contribute permissions to the website.
	AssociatedOwnerGroup	Gets or sets the associated owner groups of the website.
	AssociatedVisitorGroup	Gets or sets the associated visitor group of the website.
	Audit	Gets the audit log that is associated with the website.
	AuthenticationMode	Obsolete. Reserved for internal use.
	Author	Gets or sets a user object that represents the user who created the website. (Read-only in sandboxed solutions.)
	AvailableContentTypes	Gets the collection of all content type templates that apply to the current scope, including those of the current website, as well as any parent websites.
	AvailableFields	Gets the collection of the available fields of the website.
	CacheAllSchema	Gets or sets a Boolean value that specifies whether caching of all schemas on the website is enabled.
	ClientTag	The client cache control number (client tag) for this website.
	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 used to create the site was derived.
	ContentTypes	Gets the collection of content types for the website.
	Created	Gets or sets a date and time value that indicates when the site was created. (Read-only in sandboxed solutions.)
	CurrencyLocaleID	Gets the locale identifier (LCID) that is used for currency in the website.
	CurrentChangeToken	Gets the change token that is used when the next change is logged to the website.
	CurrentUser	Gets the current user of the site.
	CustomJavaScriptFileUrl	The custom ECMAScript (JavaScript, JScript) file URL used by the CustomJsUrl web control.
	CustomMasterUrl	Gets or sets the URL for a custom master page file to apply to the website.
	CustomUploadPage	Gets or sets the path to a custom application page for uploading files.
	DataRetrievalServicesSettings	Obsolete. Gets an object that represents the data retrieval service settings for the deployment of SharePoint Foundation.
	Description	Gets or sets the description for the site.
	DescriptionResource	Gets an SPUserResource object that represents the translations for the description of the site.
	DocTemplates	Gets the collection of document templates that are used on the site.
	EffectiveBasePermissions	Gets the effective base permissions that are assigned to the current user. (Overrides SPSecurableObject.EffectiveBasePermissions.)
	EffectivePresenceEnabled	Gets a Boolean value that indicates whether effective presence information is enabled on the site.
	EmailInsertsEnabled	Obsolete. Gets a Boolean value that indicates whether document libraries on the virtual server can accept e-mail attachments from public folders.
	EventHandlersEnabled	Obsolete. Gets a Boolean value that indicates whether Windows SharePoint Services 2.0 event handlers can be used on the site.
	EventReceivers	Gets the collection of event receiver definitions that are currently available on the website.
	ExcludeFromOfflineClient	Gets or sets a value that indicates whether the data from the website should be downloaded to the client during offline synchronization.
	ExecuteUrl	Gets the URL that is called after the site definition for a business solutions site is instantiated.
	Exists	Gets a Boolean value that indicates whether the website exists.
	ExternalSecurityProviderSetting	Obsolete. Gets the settings that are used by an external security provider for the site.
	Features	Gets the collection of Features that are currently activated in the website.
	Fields	Gets the collection of field objects that represents all the fields in the website.
	FieldTypeDefinitionCollection	Gets the collection of SPFieldTypeDefinition objects that represents type definition information for the fields of the website.
	FileDialogPostProcessorId	Gets or sets the Class Identifier (CLSID) for the user interface element that is used for Web views in the file dialog boxes and forms of document libraries.
	Files	Gets the collection of all files in the root directory of the website.
	FirstUniqueAncestor	Obsolete. Use the FirstUniqueAncestorSecurableObject property instead. (Inherited from SPSecurableObject.)
	FirstUniqueAncestorSecurableObject	An ISecurableObject interface that represents the first unique ancestor website. This is the object where the ACL is defined. For a web with unique permission the First Unique Ancestor is itself. For a web that inherits permissions the First Unique Ancestor is one of the ancestral webs. (Overrides SPSecurableObject.FirstUniqueAncestorSecurableObject.)
	FirstUniqueAncestorWeb	Gets the first parent website that has unique permissions.
	FirstUniqueRoleDefinitionWeb	Gets the website where the role definitions for the current site were defined.
	Folders	Gets the collection of all first-level folders in the website.
	Groups	Gets a collection that contains all the groups for the website.
	HasExternalSecurityProvider	Obsolete. Gets a Boolean value that indicates whether the site uses an external security provider.
	HasUniquePerm	Obsolete. Gets or sets a Boolean value that specifies whether the site has unique permissions.
	HasUniqueRoleAssignments	Indicates whether the object has unique role assignments or inherits its role assignments from a parent object. (Inherited from SPSecurableObject.)
	HasUniqueRoleDefinitions	Gets a Boolean value that indicates whether the role definitions are uniquely defined for this website or inherited from a parent website.
	ID	Gets the GUID for the site.
	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.
	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 website.
	IsADEmailEnabled	Gets a Boolean value that indicates whether e-mail for Active Directory Domain Services (AD DS)is enabled on the site.
	IsMultilingual	Gets or sets a value that indicates whether a multilingual user interface is enabled for the website.
	IsRootWeb	Gets a Boolean value that indicates whether the site is the top-level website of the site collection.
	Language	Gets the locale identifier (LCID) for the default language of the website.
	LastItemModifiedDate	Gets or sets the date and time that an item was last modified in the site. (Read-only in sandboxed solutions.)
	Lists	Gets the collection of all lists that are contained in the website.
	ListTemplates	Gets the collection of all list definitions and list templates that are available for creating lists on the website.
	Locale	Gets or sets the locale that is used when time, currency and numeric fields are rendered on the website.
	MasterPageReferenceEnabled	Retrieves a Boolean value that indicates whether the website is enabled for master page referencing.
	MasterUrl	Gets or sets the URL of the master page that is used for the website.
	Modules	Gets the collection of modules that are used on the website.
	Name	Gets or sets the name of the website.
	Navigation	Gets a navigation object that represents navigation on the website, including the Quick Launch area and the top navigation bar.
	NoCrawl	Gets or sets a Boolean value that specifies whether searching is enabled for the website.
	OverwriteTranslationsOnChange	Gets and sets a Boolean value that indicates whether changes made to user-specified text in the default language should automatically overwrite existing translations made in all alternate languages.
	ParentWeb	Gets the parent website of the specified website.
	ParentWebId	Gets the identifier (ID) of the parent website for the site.
	ParserEnabled	Gets or sets a value that specifies whether parsing is enabled for document libraries of the website.
	Permissions	Obsolete. Gets the collection of permissions for the website.
	PortalMember	Gets a Boolean value that indicates whether the website is associated with a portal site.
	PortalName	Gets the name of a portal site that is associated with the site.
	PortalSubscriptionUrl	Gets the URL that is used for alerts within a portal.
	PortalUrl	Gets the URL to a portal site that is associated with the site.
	PresenceEnabled	Gets or sets a Boolean value that specifies whether inline presence information is enabled on the website.
	Properties	Gets a SPPropertyBag object with the metadata for the website.
	Provisioned	Gets a Boolean value that indicates whether the website has been provisioned.
	PublicFolderRootUrl	Obsolete. Gets the URL of the public folder that is used for e-mail attachments in document libraries.
	QuickLaunchEnabled	Gets or sets a Boolean value that specifies whether the Quick Launch area is enabled on the website.
	RecycleBin	Gets the recycle bin of the website.
	RecycleBinEnabled	Gets or sets a value that determines whether the recycle bin is enabled for the website.
	RegionalSettings	Gets the regional settings that are currently implemented on the website.
	RequestAccessEmail	Gets or sets the e-mail address to which requests for access are sent.
	RequestAccessEnabled	Gets a Boolean value that indicates whether request for access to the website is enabled.
	ReusableAcl	Gets the reusable access control list (ACL) for the website. (Overrides SPSecurableObject.ReusableAcl.)
	RoleAssignments	Gets the role assignments for this securable object. (Inherited from SPSecurableObject.)
	RoleDefinitions	Gets the collection of role definitions for the website.
	Roles	Obsolete. Use the RoleDefinitions property to get the collection of role definitions for a website. In Windows SharePoint Services 2.0, the Roles property was used to get the collection of site groups on the website.
	RootFolder	Gets the root folder for the website.
	ServerRelativeUrl	Gets or sets the server-relative URL for the website.
	ShowUrlStructureForCurrentUser	Retrieves a Boolean value that specifies whether the current user is allowed to see the file structure of the current site. The default value is false.
	Site	Gets the parent site collection for the website.
	SiteAdministrators	Gets the collection of the website administrators.
	SiteGroups	Gets a collection that contains all the groups in the site collection.
	SiteLogoDescription	Gets or sets the description of the website logo.
	SiteLogoUrl	Gets or sets the absolute URL of the website logo.
	SiteUserInfoList	Gets the UserInfo list of the site collection that contains the website.
	SiteUsers	Gets the collection of all users that belong to the site collection.
	SupportedUICultures	Gets an enumerable collection of objects with information about cultures supported by the website.
	SyndicationEnabled	Gets or sets a value that specifies whether Really Simple Syndication (RSS) is enabled in the website.
	Theme	Gets the name of the theme that is applied to the website.
	ThemeCssUrl	Gets the URL for the cascading style sheets file that is used in the theme for the website.
	ThemedCssFolderUrl	Gets or sets the URL to the folder that contains the cascading style sheets (CSS) file that is used in the theme for the website.
	Title	Gets or sets the title for the website.
	TitleResource	Gets an SPUserResource object that represents the translations for the title of the website.
	TreeViewEnabled	Gets or sets a Boolean value that specifies whether the SharePoint Foundation TreeView is enabled in the left navigational area of website pages.
	UICulture	Gets a CultureInfo object that represents to the default language for the website.
	UIVersion	Gets or sets the current version number of the user interface.
	UIVersionConfigurationEnabled	Gets or sets a value that indicates whether to enable the user interface (UI) for changing the version of the UI.
	Url	Gets the absolute URL for the website.
	UserCustomActions	Retrieves a refreshed SPUserCustomActionCollection.
	UserIsSiteAdmin	Gets a Boolean value that indicates whether the user has administrative rights on the website, including ManageSubwebs, ManagePermissions, and ManageWeb permissions.
	UserIsWebAdmin	Gets a Boolean value that indicates whether the user is a member of the Administrator site group for the site.
	UserResources	Gets the collection of user-defined localized resources scoped to the current website.
	Users	Gets the collection of user objects that are explicitly assigned permissions in the website.
	ViewStyles	Gets the collection of view styles for the website.
	Webs	Gets a website collection object that represents all websites immediately beneath the website, excluding children of those websites.
	WebTemplate	Gets the name of the site definition or site template that was used to create the site.
	WebTemplateId	Gets the identifier (ID) of the site definition that was used to create the site.
	WorkflowAssociations	Gets the collection of workflow association objects that represents all the workflows that are associated with the website.
	Workflows	Gets the collection of workflow instances that are running or have run on the website.
	WorkflowTemplates	Gets the collection of workflow templates of the website.

Top

Methods

	Name	Description
	AddApplicationPrincipal	Adds a user to the website as an application principal; that is, a user object that is delegated to act on behalf of an external application.
	AddProperty	Adds a property to the list of metadata for the website.
	AddSupportedUICulture	Adds culture-specific information to the list supported by the website.
	AllowAllWebTemplates	Resets the available web templates on the website to the complete set of web templates.
	ApplyTheme	Applies a theme to a website.
	ApplyWebTemplate(String)	Applies the specified site definition or site template to the website that has no template applied to it.
	ApplyWebTemplate(SPWebTemplate)	Applies the specified site definition object or site template object to the website that has no template applied to it.
	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 website, optionally copies role assignments from the parent website, and optionally clears unique role assignments from descendants. (Overrides SPSecurableObject.BreakRoleInheritance(Boolean, Boolean).)
	BypassUseRemoteApis	Accesses the website by bypassing the SOAP, WebDAV and Microsoft Office SharePoint Designer 2007 interfaces.
	CheckPermissions	Determines whether the current user has a specified set of permissions. (Inherited from SPSecurableObject.)
	Close	Closes the website at the end of a request and releases resources.
	CreateDefaultAssociatedGroups	Creates an owner group.
	CustomizeCss	Customizes the specified style sheet for the website.
	Delete	Deletes the website.
	DeleteProperty	Deletes a property from the list of metadata for the website.
	Dispose	Releases all resources used by the current instance of the website.
	DoesUserHavePermissions(SPBasePermissions)	Indicates whether the current user has a specified set of permissions. (Inherited from SPSecurableObject.)
	DoesUserHavePermissions(String, SPBasePermissions)	Indicates whether the specified user has a specified set of permissions.
	EnsureUser	Checks whether the specified logon name belongs to a valid user of the website, and if the logon name does not already exist, adds it to the website.
	Equals	(Inherited from Object.)
	ExportUserResources	Exports user resources for a given language.
	Finalize	(Inherited from Object.)
	GetAvailableCrossLanguageWebTemplates	Returns the collection of available cross-language web templates.
	GetAvailableWebTemplates(UInt32)	Gets the Web templates that are available for creating subsites beneath the website, based on the specified locale identifier (ID).
	GetAvailableWebTemplates(UInt32, Boolean)	Gets the site templates that are available for creating subsites beneath the website, based on the specified locale identifier (ID) and whether to include language-neutral site templates.
	GetCatalog	Gets the list template gallery, site template gallery, or Web Parts page gallery for the website.
	GetChanges()	Gets all of changes listed in the current change log for the website.
	GetChanges(SPChangeQuery)	Gets changes from the change log filtered by the specified query.
	GetChanges(SPChangeToken)	Gets the changes starting from a specified point in the change log.
	GetChanges(SPChangeToken, SPChangeToken)	Gets the changes logged over a specified period of time.
	GetDocDiscussions	Obsolete. Returns the collection of document discussion objects for the specified directory in the site.
	GetFieldLocalizations	Returns the collection of localizations for the website for the specified culture.
	GetFile(Guid)	Gets the file object with the specified identifier (ID).
	GetFile(String)	Retrieves the file object located at the specified URL.
	GetFileAsString	Gets the contents of the file object located at the specified URL as a string.
	GetFileOrFolderObject	Retrieves a file or folder on the website with the specified URL.
	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.
	GetFolder(Guid)	Retrieves the folder object with the specified GUID.
	GetFolder(String)	Gets the folder that is located at the specified URL.
	GetHashCode	(Inherited from Object.)
	GetLimitedWebPartManager	Returns the limited Web Part Manager for the specified Web Part page and view.
	GetList	Gets the list that is associated with the specified server-relative URL.
	GetListFromUrl	Gets the list that is associated with the first Web Part on the specified Web Parts page. Beginning in Windows SharePoint Services 3.0, use the GetListFromWebPartPageUrl method instead of this method.
	GetListFromWebPartPageUrl	Gets the list that is associated with the first Web Part on the specified Web Parts page.
	GetListItem	Gets the list item that is associated with the specified server-relative URL.
	GetListItemFields	Gets the list item that is associated with the specified server-relative URL, returning data for only the specified fields.
	GetListsOfType	Gets the lists of the specified type.
	GetObject	Retrieves a file, folder, or list item that is associated with the specified URL.
	GetProperty	Gets the value of a property with the specified key from the list of metadata for the website.
	GetRecycleBinItems	Gets the recycle bin items that are based on the specified query.
	GetSiteData	Gets the list items across multiple lists, which can be located in multiple websites in the same website collection.
	GetSubwebsForCurrentUser()	Gets the subsites beneath the current site of which the current user is a member.
	GetSubwebsForCurrentUser(Int32)	Gets the subsites beneath the current website of which the current user is a member based on the specified site definition.
	GetSubwebsForCurrentUser(Int32, Int16)	Gets the subsites beneath the current website in which the current user is a member, based on the specified site definition and configuration.
	GetType	(Inherited from Object.)
	GetUsageData(SPUsageReportType, SPUsagePeriodType)	Gets a table that contains information about the usage of a website, based on the specified report type and time interval.
	GetUsageData(SPUsageReportType, SPUsagePeriodType, Int32, DateTime)	Gets a table that contains information about the usage of a website based on the specified report type, time interval, number of columns to display, and last day to display.
	GetUserEffectivePermissionInfo	Gets the effective permissions that the specified user has and the role assignments related to this user within this scope. (Overrides SPSecurableObject.GetUserEffectivePermissionInfo(String).)
	GetUserEffectivePermissions	Gets the effective permissions that the specified user has within the current application scope. (Overrides SPSecurableObject.GetUserEffectivePermissions(String).)
	GetUserToken	Retrieves the user token for the specified user.
	GetViewFromUrl	Gets a view of a list within the site based on the specified URL.
	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.)
	GetWebsAndListsWithUniquePermissions	Retrieves a collection of Webs and Lists that either have unique permissions themselves or have items with unique permissions.
	ImportUserResources	Imports user resources for the specified language.
	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).
	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).
	IsCurrentUserMemberOfGroup	Gets whether the current user is a member of the specified group.
	MemberwiseClone	(Inherited from Object.)
	OriginalBaseUrl	Returns the base URL for the current request.
	ProcessBatchData	Processes the specified commands for sending multiple requests to the server per transaction.
	RecalculateWebFineGrainedPermissions	Recalculates whether the website contains a list or list item that has unique permissions, and updates the value of the AllowAutomaticASPXPageIndexing property.
	Recycle	Sends the website to the recycle bin.
	RemoveExternalSecurityProvider	Obsolete. Removes the external security provider for the website.
	RemoveSupportedUICulture	Removes support for the specified culture (locale) from the website.
	ResetRoleInheritance	Resets the local role assignments and inherits role assignments from the parent website. (Overrides SPSecurableObject.ResetRoleInheritance().)
	RevertAllDocumentContentStreams	Restores all files within the website to their original, uncustomized state so that their logic becomes cached in memory (also known as "ghosted") rather than stored within the database.
	RevertCss	Reverts style sheet customization of a file to the default style sheet.
	SaveAsTemplate	Saves the website as a site template solution.
	SearchDocuments(String)	This class or member is deprecated. When you upgrade or write new applications that use this class or member, use the new class or member instead. Use the Execute method of the Microsoft.SharePoint.Search.Query.KeywordQuery class or the Microsoft.SharePoint.Search.Query.FullTextSqlQuery class instead.
	SearchDocuments(String, UInt32, SPSearchResultCollectionPosition)	This class or member is deprecated. When you upgrade or write new applications that use this class or member, use the new class or member instead. Use the Execute method of the Microsoft.SharePoint.Search.Query.KeywordQuery class or the Microsoft.SharePoint.Search.Query.FullTextSqlQuery class instead.
	SearchListItems(String)	This class or member is deprecated. When you upgrade or write new applications that use this class or member, use the new class or member instead. Use the Execute method of the Microsoft.SharePoint.Search.Query.KeywordQuery class or the Microsoft.SharePoint.Search.Query.FullTextSqlQuery class instead.
	SearchListItems(String, UInt32, SPSearchResultCollectionPosition)	This class or member is deprecated. When you upgrade or write new applications that use this class or member, use the new class or member instead. Use the Execute method of the Microsoft.SharePoint.Search.Query.KeywordQuery class or the Microsoft.SharePoint.Search.Query.FullTextSqlQuery class instead.
	SetAvailableCrossLanguageWebTemplates	Specifies a set of language-neutral Web templates that are available for creating subsites below the website, regardless of locale.
	SetAvailableWebTemplates	Specifies the Web templates that are available for creating subsites below the website for the specified locale.
	SetProperty	Sets the value of a property with the specified key in the list of metadata for the website.
	ToString	Returns the title of the website. (Overrides Object.ToString().)
	Update	Updates the database with changes that are made to the website.
	ValidateFormDigest	Validates the form digest control that is used in the current request.

Top

See Also

Reference

SPWeb Class

Microsoft.SharePoint Namespace