SPWeb properties
The SPWeb type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
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. |
|
AllowCreateDeclarativeWorkflowForCurrentUser | |
|
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. |
|
AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser | |
|
AllowSavePublishDeclarativeWorkflowForCurrentUser | |
|
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. |
|
AppDatabaseName | Gets the name of the app database associated with this Web. This property can be a null reference (Nothing in Visual Basic). |
|
AppDatabaseServerReferenceId | Gets the reference identifier of the server where the database is located. This property can be a null reference (Nothing in Visual Basic). |
|
AppDatabaseTargetApplicationId | Gets the name of the target application. |
|
AppInstanceId | The instance Id of the App Instance that this web represents. Guid.Empty if this is not an app web. |
|
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. |
|
ClientFormWebData | Returns a dictionary containing web properties used in CSR Forms |
|
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 JavaScript 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. |
|
DesignerDownloadUrlForCurrentUser | |
|
DocTemplates | Gets the collection of document templates that are used on the site. |
|
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled | Determines if the Document Library Callout's WAC previewers are enabled or not. |
|
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. |
|
EnableMinimalDownload | Gets or sets a Boolean value that specifies whether the Web site should use Minimal Download Strategy |
|
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. |
|
FeatureDefinitions | FeatureDefinitions for the Web |
|
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. |
|
HideSiteContentsLink | Controls the appearance of the “site contents” link in the gear icon (the menu known as "Site Actions" in SharePoint 2010) of the UX control. |
|
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. |
|
IndexedPropertyKeys | Gets the set of property keys for properties that need to be exposed through Site Data Web Service. |
|
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. |
|
IsAppWeb | Is this SPWeb the container web for an SPApp. |
|
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. |
|
NonHostHeaderUrl | Gets the full url non-isolated url of the Web site. |
|
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. |
|
PushNotificationSubscribers | Gets the collection of push notification subscribers over the site. |
|
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. |
|
RequireDynamicCanary | If true, the canary is required for all requests to this UrlZone including web service requests |
|
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. |
|
SaveSiteAsTemplateEnabled | Gets or sets a Boolean value that specifies whether the Web site can be saved as a site template. |
|
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. |
|
SiteClientTag | The client cache control number (client tag) for this Site Collection. |
|
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. |
|
Solutions | UserSolutions Activated for the Web. |
|
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 | Obsolete. Gets the name of the theme that is applied to the website. |
|
ThemeCssUrl | Obsolete. 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. |
|
ThemeInfo | The theming information for this SPWeb. This includes information like colors, fonts, border radii sizes etc. |
|
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 | Obsolete. 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