SPWeb SPWeb SPWeb Class

Definition

Namespace:
Microsoft.SharePoint Microsoft.SharePoint Microsoft.SharePoint
Assembly:
Microsoft.SharePoint.dll
public ref class SPWeb : Microsoft::SharePoint::SPSecurableObject, IDisposable
[Microsoft.SharePoint.Client.ClientCallableType(DeleteMethodClientName="DeleteObject", EntityKeyPropertyNames="ID", FactoryType=typeof(Microsoft.SharePoint.SPObjectFactory), Name="Web", ObjectIdentityPropertyName="CanonicalId", ObjectUrlPathPropertyName="Microsoft.SharePoint.SPObjectUrlPath.GetUrlPath", PatchUpdateMethodClientName="Update", PutUpdateMethodClientName="Update", SampleUrl="{apiroot}/web", ServerTypeId="{A489ADD2-5D3A-4de8-9445-49259462DCEB}")]
[Microsoft.SharePoint.Client.SubsetCallableType(ForcePolymorphicForReturnTypes=true)]
[Microsoft.SharePoint.Upgrade.Upgradable]
public class SPWeb : Microsoft.SharePoint.SPSecurableObject, IDisposable
Public Class SPWeb
Inherits SPSecurableObject
Implements IDisposable
Inheritance
ObjectObjectObject
SPSecurableObjectSPSecurableObjectSPSecurableObject
SPWebSPWebSPWeb
Attributes
Microsoft.SharePoint.Client.ClientCallableTypeAttribute Microsoft.SharePoint.Client.SubsetCallableTypeAttribute UpgradableAttribute
Implements
IDisposableIDisposableIDisposable

Properties

Alerts Alerts Alerts
AllowAnonymousAccess AllowAnonymousAccess AllowAnonymousAccess
AllowAutomaticASPXPageIndexing AllowAutomaticASPXPageIndexing AllowAutomaticASPXPageIndexing
AllowCreateDeclarativeWorkflowForCurrentUser AllowCreateDeclarativeWorkflowForCurrentUser AllowCreateDeclarativeWorkflowForCurrentUser
AllowDesignerForCurrentUser AllowDesignerForCurrentUser AllowDesignerForCurrentUser
AllowMasterPageEditingForCurrentUser AllowMasterPageEditingForCurrentUser AllowMasterPageEditingForCurrentUser
AllowRevertFromTemplateForCurrentUser AllowRevertFromTemplateForCurrentUser AllowRevertFromTemplateForCurrentUser
AllowRssFeeds AllowRssFeeds AllowRssFeeds
AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser
AllowSavePublishDeclarativeWorkflowForCurrentUser AllowSavePublishDeclarativeWorkflowForCurrentUser AllowSavePublishDeclarativeWorkflowForCurrentUser
AllowUnsafeUpdates AllowUnsafeUpdates AllowUnsafeUpdates
AllProperties AllProperties AllProperties
AllRolesForCurrentUser AllRolesForCurrentUser AllRolesForCurrentUser Inherited from SPSecurableObject
AllUsers AllUsers AllUsers
AllWebTemplatesAllowed AllWebTemplatesAllowed AllWebTemplatesAllowed
AlternateCssUrl AlternateCssUrl AlternateCssUrl
AlternateHeader AlternateHeader AlternateHeader
AnonymousPermMask64 AnonymousPermMask64 AnonymousPermMask64
AnonymousState AnonymousState AnonymousState
AppDatabaseName AppDatabaseName AppDatabaseName
AppDatabaseServerReferenceId AppDatabaseServerReferenceId AppDatabaseServerReferenceId
AppDatabaseTargetApplicationId AppDatabaseTargetApplicationId AppDatabaseTargetApplicationId
AppInstanceId AppInstanceId AppInstanceId
ASPXPageIndexed ASPXPageIndexed ASPXPageIndexed
ASPXPageIndexMode ASPXPageIndexMode ASPXPageIndexMode
AssociatedGroups AssociatedGroups AssociatedGroups
AssociatedMemberGroup AssociatedMemberGroup AssociatedMemberGroup
AssociatedOwnerGroup AssociatedOwnerGroup AssociatedOwnerGroup
AssociatedVisitorGroup AssociatedVisitorGroup AssociatedVisitorGroup
Audit Audit Audit
AuthenticationMode AuthenticationMode AuthenticationMode
Author Author Author
AvailableContentTypes AvailableContentTypes AvailableContentTypes
AvailableFields AvailableFields AvailableFields
CacheAllSchema CacheAllSchema CacheAllSchema
ClientFormWebData ClientFormWebData ClientFormWebData
ClientTag ClientTag ClientTag
Configuration Configuration Configuration
ContentTypes ContentTypes ContentTypes
Created Created Created
CurrencyLocaleID CurrencyLocaleID CurrencyLocaleID
CurrentChangeToken CurrentChangeToken CurrentChangeToken
CurrentUser CurrentUser CurrentUser
CustomJavaScriptFileUrl CustomJavaScriptFileUrl CustomJavaScriptFileUrl
CustomMasterUrl CustomMasterUrl CustomMasterUrl
CustomUploadPage CustomUploadPage CustomUploadPage
DataRetrievalServicesSettings DataRetrievalServicesSettings DataRetrievalServicesSettings
Description Description Description
DescriptionResource DescriptionResource DescriptionResource
DesignerDownloadUrlForCurrentUser DesignerDownloadUrlForCurrentUser DesignerDownloadUrlForCurrentUser
DocTemplates DocTemplates DocTemplates
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled DocumentLibraryCalloutOfficeWebAppPreviewersDisabled DocumentLibraryCalloutOfficeWebAppPreviewersDisabled
EffectiveBasePermissions EffectiveBasePermissions EffectiveBasePermissions
EffectivePresenceEnabled EffectivePresenceEnabled EffectivePresenceEnabled
EmailInsertsEnabled EmailInsertsEnabled EmailInsertsEnabled
EnableMinimalDownload EnableMinimalDownload EnableMinimalDownload
EventHandlersEnabled EventHandlersEnabled EventHandlersEnabled
EventReceivers EventReceivers EventReceivers
ExcludeFromOfflineClient ExcludeFromOfflineClient ExcludeFromOfflineClient
ExecuteUrl ExecuteUrl ExecuteUrl
Exists Exists Exists
ExternalSecurityProviderSetting ExternalSecurityProviderSetting ExternalSecurityProviderSetting
FeatureDefinitions FeatureDefinitions FeatureDefinitions
Features Features Features
Fields Fields Fields
FieldTypeDefinitionCollection FieldTypeDefinitionCollection FieldTypeDefinitionCollection
FileDialogPostProcessorId FileDialogPostProcessorId FileDialogPostProcessorId
Files Files Files
FirstUniqueAncestor FirstUniqueAncestor FirstUniqueAncestor Inherited from SPSecurableObject
FirstUniqueAncestorSecurableObject FirstUniqueAncestorSecurableObject FirstUniqueAncestorSecurableObject
FirstUniqueAncestorWeb FirstUniqueAncestorWeb FirstUniqueAncestorWeb
FirstUniqueRoleDefinitionWeb FirstUniqueRoleDefinitionWeb FirstUniqueRoleDefinitionWeb
Folders Folders Folders
Groups Groups Groups
HasExternalSecurityProvider HasExternalSecurityProvider HasExternalSecurityProvider
HasUniquePerm HasUniquePerm HasUniquePerm
HasUniqueRoleAssignments HasUniqueRoleAssignments HasUniqueRoleAssignments Inherited from SPSecurableObject
HasUniqueRoleDefinitions HasUniqueRoleDefinitions HasUniqueRoleDefinitions
HideSiteContentsLink HideSiteContentsLink HideSiteContentsLink
ID ID ID
IncludeSupportingFolders IncludeSupportingFolders IncludeSupportingFolders
IndexedPropertyKeys IndexedPropertyKeys IndexedPropertyKeys
IsADAccountCreationMode IsADAccountCreationMode IsADAccountCreationMode
IsADEmailEnabled IsADEmailEnabled IsADEmailEnabled
IsAppWeb IsAppWeb IsAppWeb
IsMultilingual IsMultilingual IsMultilingual
IsRootWeb IsRootWeb IsRootWeb
Language Language Language
LastItemModifiedDate LastItemModifiedDate LastItemModifiedDate
Lists Lists Lists
ListTemplates ListTemplates ListTemplates
Locale Locale Locale
MasterPageReferenceEnabled MasterPageReferenceEnabled MasterPageReferenceEnabled
MasterUrl MasterUrl MasterUrl
Modules Modules Modules
Name Name Name
Navigation Navigation Navigation
NoCrawl NoCrawl NoCrawl
NonHostHeaderUrl NonHostHeaderUrl NonHostHeaderUrl
OverwriteTranslationsOnChange OverwriteTranslationsOnChange OverwriteTranslationsOnChange
ParentWeb ParentWeb ParentWeb
ParentWebId ParentWebId ParentWebId
ParserEnabled ParserEnabled ParserEnabled
Permissions Permissions Permissions
PortalMember PortalMember PortalMember
PortalName PortalName PortalName
PortalSubscriptionUrl PortalSubscriptionUrl PortalSubscriptionUrl
PortalUrl PortalUrl PortalUrl
PresenceEnabled PresenceEnabled PresenceEnabled
Properties Properties Properties
Provisioned Provisioned Provisioned
PublicFolderRootUrl PublicFolderRootUrl PublicFolderRootUrl
PushNotificationSubscribers PushNotificationSubscribers PushNotificationSubscribers
QuickLaunchEnabled QuickLaunchEnabled QuickLaunchEnabled
RecycleBin RecycleBin RecycleBin
RecycleBinEnabled RecycleBinEnabled RecycleBinEnabled
RegionalSettings RegionalSettings RegionalSettings
RequestAccessEmail RequestAccessEmail RequestAccessEmail
RequestAccessEnabled RequestAccessEnabled RequestAccessEnabled
RequireDynamicCanary RequireDynamicCanary RequireDynamicCanary
ReusableAcl ReusableAcl ReusableAcl
RoleAssignments RoleAssignments RoleAssignments Inherited from SPSecurableObject
RoleDefinitions RoleDefinitions RoleDefinitions
Roles Roles Roles
RootFolder RootFolder RootFolder
SaveSiteAsTemplateEnabled SaveSiteAsTemplateEnabled SaveSiteAsTemplateEnabled
ServerRelativeUrl ServerRelativeUrl ServerRelativeUrl
ShowUrlStructureForCurrentUser ShowUrlStructureForCurrentUser ShowUrlStructureForCurrentUser
Site Site Site
SiteAdministrators SiteAdministrators SiteAdministrators
SiteClientTag SiteClientTag SiteClientTag
SiteGroups SiteGroups SiteGroups
SiteLogoDescription SiteLogoDescription SiteLogoDescription
SiteLogoUrl SiteLogoUrl SiteLogoUrl
SiteUserInfoList SiteUserInfoList SiteUserInfoList
SiteUsers SiteUsers SiteUsers
Solutions Solutions Solutions
SupportedUICultures SupportedUICultures SupportedUICultures
SyndicationEnabled SyndicationEnabled SyndicationEnabled
Theme Theme Theme
ThemeCssUrl ThemeCssUrl ThemeCssUrl
ThemedCssFolderUrl ThemedCssFolderUrl ThemedCssFolderUrl
ThemeInfo ThemeInfo ThemeInfo
Title Title Title
TitleResource TitleResource TitleResource
TreeViewEnabled TreeViewEnabled TreeViewEnabled
UICulture UICulture UICulture
UIVersion UIVersion UIVersion
UIVersionConfigurationEnabled UIVersionConfigurationEnabled UIVersionConfigurationEnabled
Url Url Url
UserCustomActions UserCustomActions UserCustomActions
UserIsSiteAdmin UserIsSiteAdmin UserIsSiteAdmin
UserIsWebAdmin UserIsWebAdmin UserIsWebAdmin
UserResources UserResources UserResources
Users Users Users
ViewStyles ViewStyles ViewStyles
Webs Webs Webs
WebTemplate WebTemplate WebTemplate
WebTemplateId WebTemplateId WebTemplateId
WorkflowAssociations WorkflowAssociations WorkflowAssociations
Workflows Workflows Workflows
WorkflowTemplates WorkflowTemplates WorkflowTemplates

Methods

AddApplicationPrincipal(String, Boolean, Boolean) AddApplicationPrincipal(String, Boolean, Boolean) AddApplicationPrincipal(String, Boolean, Boolean)
AddProperty(Object, Object) AddProperty(Object, Object) AddProperty(Object, Object)
AddSupportedUICulture(CultureInfo) AddSupportedUICulture(CultureInfo) AddSupportedUICulture(CultureInfo)
AllowAllWebTemplates() AllowAllWebTemplates() AllowAllWebTemplates()
ApplyTheme(String) ApplyTheme(String) ApplyTheme(String)
ApplyTheme(String, String, String, Boolean) ApplyTheme(String, String, String, Boolean) ApplyTheme(String, String, String, Boolean)
ApplyWebTemplate(SPWebTemplate) ApplyWebTemplate(SPWebTemplate) ApplyWebTemplate(SPWebTemplate)
ApplyWebTemplate(String) ApplyWebTemplate(String) ApplyWebTemplate(String)
BreakRoleInheritance(Boolean) BreakRoleInheritance(Boolean) BreakRoleInheritance(Boolean) Inherited from SPSecurableObject
BreakRoleInheritance(Boolean, Boolean) BreakRoleInheritance(Boolean, Boolean) BreakRoleInheritance(Boolean, Boolean)
BypassUseRemoteApis() BypassUseRemoteApis() BypassUseRemoteApis()
CheckPermissions(SPBasePermissions) CheckPermissions(SPBasePermissions) CheckPermissions(SPBasePermissions) Inherited from SPSecurableObject
Close() Close() Close()
CreateDefaultAssociatedGroups(String, String, String) CreateDefaultAssociatedGroups(String, String, String) CreateDefaultAssociatedGroups(String, String, String)
CustomizeCss(String) CustomizeCss(String) CustomizeCss(String)
Delete() Delete() Delete()
DeleteProperty(Object) DeleteProperty(Object) DeleteProperty(Object)
Dispose() Dispose() Dispose()
DoesPushNotificationSubscriberExist(Guid) DoesPushNotificationSubscriberExist(Guid) DoesPushNotificationSubscriberExist(Guid)
DoesUserHavePermissions(SPBasePermissions) DoesUserHavePermissions(SPBasePermissions) DoesUserHavePermissions(SPBasePermissions) Inherited from SPSecurableObject
DoesUserHavePermissions(String, SPBasePermissions) DoesUserHavePermissions(String, SPBasePermissions) DoesUserHavePermissions(String, SPBasePermissions)
EnsureUser(String) EnsureUser(String) EnsureUser(String)
ExportUserResources(CultureInfo, Boolean, Stream) ExportUserResources(CultureInfo, Boolean, Stream) ExportUserResources(CultureInfo, Boolean, Stream)
GetAppInstanceById(Guid) GetAppInstanceById(Guid) GetAppInstanceById(Guid)
GetAppInstancesByProductId(Guid) GetAppInstancesByProductId(Guid) GetAppInstancesByProductId(Guid)
GetAvailableCrossLanguageWebTemplates() GetAvailableCrossLanguageWebTemplates() GetAvailableCrossLanguageWebTemplates()
GetAvailableWebTemplates(UInt32) GetAvailableWebTemplates(UInt32) GetAvailableWebTemplates(UInt32)
GetAvailableWebTemplates(UInt32, Boolean) GetAvailableWebTemplates(UInt32, Boolean) GetAvailableWebTemplates(UInt32, Boolean)
GetCatalog(SPListTemplateType) GetCatalog(SPListTemplateType) GetCatalog(SPListTemplateType)
GetChanges() GetChanges() GetChanges()
GetChanges(SPChangeQuery) GetChanges(SPChangeQuery) GetChanges(SPChangeQuery)
GetChanges(SPChangeToken) GetChanges(SPChangeToken) GetChanges(SPChangeToken)
GetChanges(SPChangeToken, SPChangeToken) GetChanges(SPChangeToken, SPChangeToken) GetChanges(SPChangeToken, SPChangeToken)
GetFieldLocalizations(CultureInfo) GetFieldLocalizations(CultureInfo) GetFieldLocalizations(CultureInfo)
GetFile(Guid) GetFile(Guid) GetFile(Guid)
GetFile(String) GetFile(String) GetFile(String)
GetFileAsString(String) GetFileAsString(String) GetFileAsString(String)
GetFileOrFolderObject(String) GetFileOrFolderObject(String) GetFileOrFolderObject(String)
GetFilePersonalizationInformation(String, Boolean, SPFileLevel) GetFilePersonalizationInformation(String, Boolean, SPFileLevel) GetFilePersonalizationInformation(String, Boolean, SPFileLevel)
GetFolder(Guid) GetFolder(Guid) GetFolder(Guid)
GetFolder(String) GetFolder(String) GetFolder(String)
GetLimitedWebPartManager(String, PersonalizationScope) GetLimitedWebPartManager(String, PersonalizationScope) GetLimitedWebPartManager(String, PersonalizationScope)
GetList(String) GetList(String) GetList(String)
GetListFromUrl(String) GetListFromUrl(String) GetListFromUrl(String)
GetListFromWebPartPageUrl(String) GetListFromWebPartPageUrl(String) GetListFromWebPartPageUrl(String)
GetListItem(String) GetListItem(String) GetListItem(String)
GetListItemFields(String, String[]) GetListItemFields(String, String[]) GetListItemFields(String, String[])
GetListsOfType(SPBaseType) GetListsOfType(SPBaseType) GetListsOfType(SPBaseType)
GetObject(String) GetObject(String) GetObject(String)
GetProperty(Object) GetProperty(Object) GetProperty(Object)
GetPushNotificationSubscriber(Guid) GetPushNotificationSubscriber(Guid) GetPushNotificationSubscriber(Guid)
GetPushNotificationSubscribersByArgs(String) GetPushNotificationSubscribersByArgs(String) GetPushNotificationSubscribersByArgs(String)
GetPushNotificationSubscribersByUser(String) GetPushNotificationSubscribersByUser(String) GetPushNotificationSubscribersByUser(String)
GetRecycleBinItems(SPRecycleBinQuery) GetRecycleBinItems(SPRecycleBinQuery) GetRecycleBinItems(SPRecycleBinQuery)
GetServerRelativeUrlFromUrl(String) GetServerRelativeUrlFromUrl(String) GetServerRelativeUrlFromUrl(String)
GetSiteAppPrincipals() GetSiteAppPrincipals() GetSiteAppPrincipals()
GetSiteData(SPSiteDataQuery) GetSiteData(SPSiteDataQuery) GetSiteData(SPSiteDataQuery)
GetSubwebsForCurrentUser() GetSubwebsForCurrentUser() GetSubwebsForCurrentUser()
GetSubwebsForCurrentUser(Int32) GetSubwebsForCurrentUser(Int32) GetSubwebsForCurrentUser(Int32)
GetSubwebsForCurrentUser(Int32, Int16) GetSubwebsForCurrentUser(Int32, Int16) GetSubwebsForCurrentUser(Int32, Int16)
GetUsageData(SPUsageReportType, SPUsagePeriodType) GetUsageData(SPUsageReportType, SPUsagePeriodType) GetUsageData(SPUsageReportType, SPUsagePeriodType)
GetUsageData(SPUsageReportType, SPUsagePeriodType, Int32, DateTime) GetUsageData(SPUsageReportType, SPUsagePeriodType, Int32, DateTime) GetUsageData(SPUsageReportType, SPUsagePeriodType, Int32, DateTime)
GetUserEffectivePermissionInfo(String) GetUserEffectivePermissionInfo(String) GetUserEffectivePermissionInfo(String)
GetUserEffectivePermissions(String) GetUserEffectivePermissions(String) GetUserEffectivePermissions(String)
GetUserToken(String) GetUserToken(String) GetUserToken(String)
GetViewFromUrl(String) GetViewFromUrl(String) GetViewFromUrl(String)
GetWebPartCollection(String, Storage) GetWebPartCollection(String, Storage) GetWebPartCollection(String, Storage)
GetWebsAndListsWithUniquePermissions() GetWebsAndListsWithUniquePermissions() GetWebsAndListsWithUniquePermissions()
ImportUserResources(CultureInfo, Stream) ImportUserResources(CultureInfo, Stream) ImportUserResources(CultureInfo, Stream)
InsertAlertEvent(Guid, String, Int32, Byte[]) InsertAlertEvent(Guid, String, Int32, Byte[]) InsertAlertEvent(Guid, String, Int32, Byte[])
InsertAlertEvent(Guid, String, Int32, SPReusableAcl) InsertAlertEvent(Guid, String, Int32, SPReusableAcl) InsertAlertEvent(Guid, String, Int32, SPReusableAcl)
IsCurrentUserMemberOfGroup(Int32) IsCurrentUserMemberOfGroup(Int32) IsCurrentUserMemberOfGroup(Int32)
LoadAndInstallApp(Stream) LoadAndInstallApp(Stream) LoadAndInstallApp(Stream)
LoadAndInstallAppInSpecifiedLocale(Stream, Int32) LoadAndInstallAppInSpecifiedLocale(Stream, Int32) LoadAndInstallAppInSpecifiedLocale(Stream, Int32)
LoadApp(Stream, Int32) LoadApp(Stream, Int32) LoadApp(Stream, Int32)
OriginalBaseUrl(HttpRequest) OriginalBaseUrl(HttpRequest) OriginalBaseUrl(HttpRequest)
ProcessBatchData(String) ProcessBatchData(String) ProcessBatchData(String)
RecalculateWebFineGrainedPermissions() RecalculateWebFineGrainedPermissions() RecalculateWebFineGrainedPermissions()
Recycle() Recycle() Recycle()
RegisterPushNotificationSubscriber(Guid, String) RegisterPushNotificationSubscriber(Guid, String) RegisterPushNotificationSubscriber(Guid, String)
RemoveExternalSecurityProvider() RemoveExternalSecurityProvider() RemoveExternalSecurityProvider()
RemoveSupportedUICulture(CultureInfo) RemoveSupportedUICulture(CultureInfo) RemoveSupportedUICulture(CultureInfo)
ResetRoleInheritance() ResetRoleInheritance() ResetRoleInheritance()
RevertAllDocumentContentStreams() RevertAllDocumentContentStreams() RevertAllDocumentContentStreams()
RevertCss(String) RevertCss(String) RevertCss(String)
SaveAsTemplate(String, String, String, Boolean) SaveAsTemplate(String, String, String, Boolean) SaveAsTemplate(String, String, String, Boolean)
SearchDocuments(String) SearchDocuments(String) SearchDocuments(String)
SearchDocuments(String, UInt32, SPSearchResultCollectionPosition) SearchDocuments(String, UInt32, SPSearchResultCollectionPosition) SearchDocuments(String, UInt32, SPSearchResultCollectionPosition)
SearchListItems(String) SearchListItems(String) SearchListItems(String)
SearchListItems(String, UInt32, SPSearchResultCollectionPosition) SearchListItems(String, UInt32, SPSearchResultCollectionPosition) SearchListItems(String, UInt32, SPSearchResultCollectionPosition)
SetAvailableCrossLanguageWebTemplates(Collection<SPWebTemplate>) SetAvailableCrossLanguageWebTemplates(Collection<SPWebTemplate>) SetAvailableCrossLanguageWebTemplates(Collection<SPWebTemplate>)
SetAvailableWebTemplates(Collection<SPWebTemplate>, UInt32) SetAvailableWebTemplates(Collection<SPWebTemplate>, UInt32) SetAvailableWebTemplates(Collection<SPWebTemplate>, UInt32)
SetProperty(Object, Object) SetProperty(Object, Object) SetProperty(Object, Object)
ToString() ToString() ToString()
UnregisterPushNotificationSubscriber(Guid) UnregisterPushNotificationSubscriber(Guid) UnregisterPushNotificationSubscriber(Guid)
Update() Update() Update()
ValidateFormDigest() ValidateFormDigest() ValidateFormDigest()

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to