SPSite properties (Microsoft.SharePoint) (original) (raw)

Skip to main content

This browser is no longer supported.

Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.

SPSite properties

In this article

The SPSite type exposes the following members.

Properties

| | Name | Description | | | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Public property | AdministrationSiteType | Represents administration site types supported by SharePoint Foundation. | | Public property | AllowCreateDeclarativeWorkflow | | | Public property | AllowDesigner | Used to assign or retrieve the Site Collection Allow Designer property. | | Public property | AllowExternalEmbedding | Setting that controls external domain embedding for this site collection | | Public property | AllowMasterPageEditing | Used to assign or retrieve the Site Collection property that allows master page editing. | | Public property | AllowRevertFromTemplate | Used to assign or retrieve the Site Collection property that allows reverting from a template. | | Public property | AllowRssFeeds | Gets a Boolean value that specifies whether the site collection allows RSS feeds. | | Public property | AllowSaveDeclarativeWorkflowAsTemplate | | | Public property | AllowSavePublishDeclarativeWorkflow | | | Public property | AllowSelfServiceUpgrade | whether version to version upgrade is allowed on this site. | | Public property | AllowSelfServiceUpgradeEvaluation | whether upgrade evaluation site collection is allowed. | | 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 | AllWebs | Gets the collection of all Web sites that are contained within the site collection, including the top-level site and its subsites. | | Public property | ApplicationRightsMask | Gets the rights mask for the parent Web application of the site collection. | | Public property | Archived | whether the site is in archived mode. | | Public property | Audit | Gets an audit store that is attached to the site collection. | | Public property | AuditLogTrimmingCallout | Gets or sets the class name of the object that performs audit log trimming. | | Public property | AuditLogTrimmingRetention | Gets or sets the number of days of audit log data to retain. | | Public property | AverageResourceUsage | the average resource usage of the site collection over the configured window in days. | | Public property | BrowserDocumentsEnabled | Indicates whether the documents can be opened in a browser or not. | | Public property | Cache | A thread-safe cache that may be used to store very small amounts of data associated with this SPSite. | | Public property | CanUpgrade | Property indicating whether or not this object can be upgraded. | | Public property | CatchAccessDeniedException | Reserved for internal use. Use the CatchAccessDeniedException property instead to specify whether SharePoint Foundation traps and handles “Access Denied” exceptions. | | Public property | CertificationDate | Gets the date and time on which use of the site collection was confirmed for automatic deletion. | | Public property | CompatibilityLevel | Gets the major version of this site collection for purposes of major version-level compatibility checks. | | Public property | ContentDatabase | Gets the content database that is associated with the site collection. | | Public property | CurrentChangeToken | Gets the change token that will be used to log the next change to the site collection. | | Public property | CurrentResourceUsage | Indicates the current resource usage of the site collection. | | Public property | DeadWebNotificationCount | Gets the number of notifications that have been sent about Web sites within the site collection that are out of use. | | Public property | DenyPermissionsMask | This property will deny the rights specified by the permission mask to all users of the site collection including the site collection admin. The elevated process identity is the only exception that has full rights | | Public property | EvalSiteId | The identity of upgrade evaluation site collection, if there was one create using this site collection. Otherwise it is empty Guid value. | | Public property | EventReceivers | Provides event receivers for events that occur at the scope of the site collection. | | Public property | ExpirationDate | Specifies the date after which an upgrade evaluation site collection will automatically be deleted. | | Public property | FeatureDefinitions | Gets the collection of feature definitions for the site collection. | | Public property | Features | Gets the collection of SPFeature objects that are associated with the site collection. | | Public property | FileNotFoundUrl | Get SPSite swerver relative Url or absolute URL to file not found page. This value is used as redirect URL for HTTP request where the resource can not be found. | | Public property | GlobalPermMask | Obsolete. Use the ApplicationRightsMask property to get the rights mask for the Web application instead. (In Windows SharePoint Services 2.0, the GlobalPermMask property got the rights for the permissions mask that was used globally on the virtual server.) | | Public property | HasAppPrincipalContext | Whether this [SPSite] object is running within an app principal context. When the [SPSite] object is running within an app principal context, the request permission may be restricted by the app principal's permission, even if the [SPSite] object is created with System account. | | Public property | HideSystemStatusBar | whether the site's system status bar should be hidden. | | Public property | HostHeaderIsSiteName | Gets a Boolean value that specifies whether the host header is used instead of the server-relative path to uniquely identify the site collection. | | Public property | HostName | Gets the name of the server that hosts the site collection. | | Public property | ID | Gets the GUID that identifies the site collection. | | Public property | IISAllowsAnonymous | Gets a Boolean value that indicates whether anonymous access is enabled in Microsoft Internet Information Services (IIS). | | Public property | Impersonating | Gets a Boolean value that indicates the impersonation status of the SPSite object. | | Public property | InheritAllowSelfServiceUpgradeEvaluationSetting | whether the AllowSelfServiceUpgradeEvaluation value is inherit from parent. | | Public property | InheritAllowSelfServiceUpgradeSetting | whether the AllowSelfServiceUpgrade value is inherit from parent. | | Public property | IsEvalSite | Indicates if the site collection is an upgrade evaluation site collection or not | | Public property | IsPaired | Obsolete. Gets a Boolean value that indicates whether the site collection is paired with its parent. | | Public property | IsReadLocked | Sets or gets, a value that specifies whether the site collection is locked and unavailable for Read access. | | Public property | LastContentModifiedDate | Gets the date and time in Coordinated Universal Time (UTC) when the content of the site was last changed. | | Public property | LastSecurityModifiedDate | Gets the date and time in Coordinated Universal Time (UTC) when security on the site was last changed. | | Public property | LockIssue | Gets or sets the comment that is used in locking a site collection. | | Public property | MaintenanceMode | whether the site is in maintenance mode | | Public property | NeedsUpgrade | Property indicating whether or not this object needs to be upgraded. | | Public property | OutgoingEmailAddress | | | Public property | Owner | Gets or sets the owner of the site collection. (Read-only in sandboxed solutions.) | | Public property | Port | Gets the port number that is used for input and output on the virtual server that contains the site collection. | | Public property | PortalName | Gets or sets the name of a portal. (Read-only in sandboxed solutions.) | | Public property | PortalUrl | Gets or sets the URL to a portal. (Read-only in sandboxed solutions.) | | Public property | PrimaryUri | | | Public property | Protocol | Gets the protocol that is used by the server. | | Public property | Quota | Gets or sets a quota for the site collection. | | Public property | ReadLocked | This member is reserved for internal use and is not intended to be used directly from your code. Use the IsReadLocked property instead. | | Public property | ReadOnly | Gets or sets a Boolean value that specifies whether the site collection is read-only, locked, and unavailable for write access. | | Public property | RecycleBin | Gets the collection of recycle bin items for the site collection. | | Public property | RequiredDesignerVersion | | | Public property | ResourceQuotaExceeded | Indicates whether the resource quota limit for this site collection has been exceeded since the last daily quota reset or not. | | Public property | ResourceQuotaExceededNotificationSent | Indicates whether a resource quota exceeded notification was sent (or not) for this site collection since the last daily quota reset. | | Public property | ResourceQuotaWarningNotificationSent | Indicates whether a resource quota warning notification was sent or not for this site collection since the last daily quota reset. | | Public property | RootWeb | Gets the root Web site of the site collection. | | Public property | SchemaVersion | Gets the version of this site collection for purposes of fine-grained upgrade compatibility checks. | | Public property | ScriptSafeDomains | Returns the collection of script safe external domains for this site collection | | Public property | ScriptSafePages | Returns the collection of script safe internal pages for this site collection | | Public property | SearchServiceInstance | Gets an SPServiceInstance object that represents an instance of the SharePoint Search service that is associated with the site collection. | | Public property | SecondaryContact | Gets or sets the secondary contact that is used for the site collection. (Read-only in sandboxed solutions.) | | Public property | ServerRelativeUrl | Gets the server-relative URL of the root Web site in the site collection. | | Public property | ShareByEmailEnabled | ShareByEmailEnabled when true means that user's will be able to grant permissions to guests for resources within the site collection | | Public property | ShareByLinkEnabled | Property indicates whether that user's will be able to share links to documents that can be accessed without logging in | | Public property | ShowURLStructure | Indicates whether to show the site collection URL structure. | | Public property | SiteSubscription | Gets the subscription to which this site collection belongs. | | Public property | Solutions | Gets the collection of user solutions that have been activated for the site collection. | | Public property | SourceSiteId | Specifies the Source site Id for an Upgrade evaluation site collection. | | Public property | SyndicationEnabled | Gets or sets a Boolean value that specifies whether RSS syndication is enabled for the site collection. | | Public property | SystemAccount | Gets the system account of the site collection. | | Public property | TrimAuditLog | Gets or sets a value that specifies whether to remove excess from the audit log periodically. | | Public property | UIVersionConfigurationEnabled | Obsolete. Gets or sets a Boolean value that specifies whether to enable the visual upgrade user interface (UI) for changing the UI version of the site collection. | | Public property | UpgradeContext | Property for additional upgrade context. | | Public property | UpgradeInfo | | | Public property | UpgradeRedirectUri | Obsolete. Gets an object representation of the upgrade redirect uniform resource identifier (URI) of the site collection. | | Public property | UpgradeReminderDate | | | Public property | Upgrading | Specifies whether the site is currently upgrading. | | Public property | Url | Gets the full URL to the root Web site of the site collection, including host name, port number, and path. | | Public property | Usage | Gets information about site usage, including bandwidth, storage, and number of visits to the site collection. | | Public property | UserAccountDirectoryPath | Obsolete. Gets or sets the provider-specific user account directory path for the site collection. | | Public property | UserCodeEnabled | Gets a value that indicates whether the user code service is enabled for the site collection. | | Public property | UserCustomActions | Gets the SPUserCustomActionCollection object that contains a list of SPUserCustomAction objects that are assigned to this site. | | Public property | UserDefinedWorkflowsEnabled | Gets or sets a Boolean value that indicates whether user-defined workflows are enabled. | | Public property | UserIsSiteAdminInSystem | whether the current user is site collection admin in the system (before readonly mode trim applied) | | Public property | UserToken | Gets the user token that is associated with the site collection. | | Public property | WarningNotificationSent | Gets a Boolean value that indicates whether a warning notification has been sent. | | Public property | WebApplication | Gets the SharePoint Foundation Web application to which the site collection belongs. | | Public property | WorkflowManager | Gets the SPWorkflowManager object that is associated with the site collection, enabling you to centrally control the workflow templates and instances across the site collection. | | Public property | WriteLocked | Gets or sets a Boolean value that specifies whether the site collection is locked and unavailable for Write access. | | Public property | Zone | Gets the URL zone that was specified in the constructor that was used to create the current SPSite object. |

Top

See also

Reference

SPSite class

Microsoft.SharePoint namespace

Additional resources

In this article