SPSite members

Represents a collection of sites in a Web application, including a top-level Web site and all its subsites. Each SPSite object, or site collection, is represented within an SPSiteCollection object that consists of the collection of all site collections in the Web application.

The SPSite type exposes the following members.

Constructors

	Name	Description
	SPSite(Guid)	Initializes a new instance of the SPSite class based on the specified ID for a site collection.
	SPSite(String)	Initializes a new instance of the SPSite class based on the specified URL.
	SPSite(Guid, SPUrlZone)	Initializes a new instance of the SPSite class based on the specified site collection GUID and URL zone.
	SPSite(Guid, SPUserToken)	Initializes a new instance of the SPSite class based on the specified site collection GUID and user token.
	SPSite(String, SPUserToken)	Initializes a new instance of the SPSite class based on the specified absolute URL and user token.
	SPSite(Guid, SPUrlZone, SPUserToken)	Initializes a new instance of the SPSite class based on the specified site collection GUID, URL zone, and user token.

Top

Properties

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

Top

Methods

	Name	Description
	AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, [], String, Guid)	Adds a work item to the site collection.
	AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, [], String, Guid, Boolean)	Adds a work item to the site collection.
	BypassUseRemoteApis	Bypasses using SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the site collection.
	CheckForPermissions	Checks the permissions for a given set of rights and throws an Unauthorized Access exception if the permission check fails.
	Close	Closes the site collection and releases resources.
	ConfirmUsage	Certifies that the site collection is in use.
	CreatePreviewSPSite	Creates a temporary evaluation SPite for this SPite, for the purposes of determining whether upgrade is likely to be successful.
	Delete()	Deletes the site collection from the server.
	Delete(Boolean)	Deletes the site collection from the server and removes the site collection users from Active Directory Domain Services (ADDS) if bDeleteADAccounts is true.
	Delete(Boolean, Boolean)	Deletes the site collection from the server, optionally removes the site collection users from Active Directory Domain Services (ADDS), and optionally uses a timer job to delete the site collection gradually.
	Dispose	Releases all unmanaged resources that are used by the site collection object.
	DoesUserHavePermissions(SPReusableAcl, SPBasePermissions)	Returns a Boolean value indicates whether the user has permissions for the specified set of rights.
	DoesUserHavePermissions(SPReusableAcl, SPBasePermissions, SPWeb)	Returns a Boolean value that indicates whether the user has permissions for the specified Web site and set of rights.
	Equals	(Inherited from Object.)
	Exists(Uri)	Returns a Boolean value that indicates whether the specified site collection exists.
	Exists(Uri, Boolean)	Determines if a site with the specified uri exists. Checks the config db cache and, additionally, checks the content database if checkContentDb is true.
	ExtendUpgradeReminderDate	extend the upgrade reminder date for this SPSite by the days specified at WebApplication.UpgradeReminderDelay
	Finalize	(Inherited from Object.)
	GetAllReusableAcls()	Returns the reusable access control lists (ACLs) for the site collection.
	GetAllReusableAcls(Int32)	Returns the reusable access control lists (ACLs) of the site collection up to a specified limit.
	GetCatalog	Returns the list template gallery, site template gallery, Web Part gallery, master page gallery, or other galleries from the site collection, including custom galleries that are defined by users.
	GetChanges()	Returns the default number of changes listed in the current change log for the site collection.
	GetChanges(SPChangeQuery)	Returns a collection of changes from the change log filtered by the specified query.
	GetChanges(SPChangeToken)	Returns a collection of changes, starting from a particular point in the change log.
	GetChanges(SPChangeToken, SPChangeToken)	Returns a collection of changes that have been logged over a specified period of time.
	GetCustomListTemplates	Returns the collection of custom list templates, which are created by end users, from the specified site.
	GetCustomWebTemplates	Returns the collection of site templates for the site collection based on the specified locale ID (LCID).
	GetEffectiveRightsForAcl(SPReusableAcl)	Returns the actual permissions that the current user has for the specified Access Control List (ACL).
	GetEffectiveRightsForAcl(SPReusableAcl, SPWeb)	Returns the actual permissions that the current user has for the specified access control list (ACL).
	GetFeaturesIfLoaded	If the features have been loaded for the site, this will return them. If they have not yet been loaded, this call will return null (and will not have any round trip incurred)
	GetHashCode	(Inherited from Object.)
	GetRecycleBinItems	Returns a collection of recycle bin items based on the specified query.
	GetRecycleBinStatistics	Gets both the number of items in the recycle bin and its size.
	GetReusableAclForScope	Returns the reusable access control list (ACL) for the specified scope.
	GetSelfServiceSiteCreationSettings	Gets the settings that are used for Self-Service Site Creation.
	GetType	(Inherited from Object.)
	GetUrls	Retrieve all the URLs for the site collection, including both Primary URL and all Secondary URLs
	GetVisualReport	Retrieves a list of SPSite.WebVisualReport objects for all Web sites in this site collection and their corresponding visual upgrade data.
	GetWebTemplates(UInt32)	Returns the collection of site definitions that are available for creating Web sites within the site collection.
	GetWebTemplates(UInt32, Int32)	Returns the collection of site definitions that are available for creating Web sites within the site collection.
	GetWorkItems	Returns the individual work items, number of columns, and number of rows in the specified work item collection as output parameters.
	HasEvalSite	Determines if a site collection has an upgrade evaluation site or not.
	Invalidate	IUpgradable Interface implementation
	InvalidateCacheEntry	Removes the specified cache entry and returns a Boolean value that indicates whether the entry was cached.
	IsScriptSafe	Validates the specified uri against the script safe settings of the site collection and returns true if safe, false if not
	LookupUriInRemoteFarm	Returns the Uniform Resource Identifier (URI) of a Web site in the specified remote server farm.
	MakeFullUrl	Returns the full URL for the specified server-relative URL.
	MemberwiseClone	(Inherited from Object.)
	NeedsUpgradeByType	true if the object needs to be upgraded; otherwise, false.
	OpenWeb()	Returns the Web site that is associated with the URL that is used in an SPSite constructor.
	OpenWeb(Guid)	Returns the Web site with the specified GUID.
	OpenWeb(String)	Returns the Web site that is located at the specified server-relative or site-relative URL.
	OpenWeb(String, SPSiteOpenWebOptions)	Returns the Web site that is located at the specified server-relative or site-relative URL and applies specified options to it.
	OpenWeb(String, Boolean)	Returns the Web site that is located at the specified server-relative or site-relative URL based on a Boolean value that specifies whether the exact URL must be supplied.
	QueryFeatures(Guid)	Gets a collection of the features deployed in this site collection that have a specific definition identifier.
	QueryFeatures(Guid, Boolean)	Gets a collection of the features deployed in this site collection that have a specific definition identifier, including only features that either do or do not need to be upgraded.
	QueryFeatures(Guid, Version)	Gets a collection of the features deployed in this site collection that have a specific definition identifier and a specific version.
	QueryFeatures(SPFeatureScope, Boolean)	Gets a collection of the features deployed in this site collection with either Site or Web scope, including only features that either do or do not need to be upgraded.
	RecalculateStorageMetrics
	RecalculateStorageUsed	Recalculates the storage that is used by the site collection.
	RefreshEmailEnabledObjects	Refreshes the email–enabled objects of the site collection.
	RemoveUrl	This is the body of removing a secondary URL from site collection.
	Rename	Changes the URL of a host-header-named site collection to a new URL.
	RunHealthCheck
	RunUpgradeSiteSession
	SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String)	Creates a site collection by using Self-Service Site Creation.
	SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String)	Creates a site collection by using Self-Service Site Creation based on the specified quota template and other information.
	SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String)
	SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String, SPSiteSubscription)	Creates a site collection by using Self-Service Site Creation based on the specified quota template and other specified information (see parameter list).
	SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String, SPSiteSubscription)	Creates a site collection by using Self-Service Site Creation based on the specified quota template and other information.
	SetUrl	Set secondary URL and zone for the site collection. If the URL exist for the site collection, then we only update the zone for the existing URL. If the URL does not exist, we will add the URL and the zone for the site collection.
	StorageManagementInformation	Obsolete. Returns information about storage management for the site collection.
	ToString	Returns the name of the site collection. (Overrides Object.ToString().)
	UpdateClientObjectModelUseRemoteAPIsPermissionSetting
	UpdateValidationKey	Updates the key that is used to generate the form digest validation of the site collection.
	Upgrade()	Upgrades this object
	Upgrade(Boolean)	Upgrades this object
	ValidateDomainCompatibility(String, String)	Verifies whether two URLs point to the same site collection, even if the domain portions of the URLs are different.
	ValidateDomainCompatibility(SPSite, SPSite)	Verifies that two URLs have compatible domains.
	VisualUpgradeWebs	Obsolete. Updates all Webs in this site to the new SharePoint UI.

Top

Fields

	Name	Description
	MaxFullUrlLength	Represents the maximum number of characters that can be used in the absolute URL for a site collection.
	MaxWebNameLength	Represents the maximum number of characters that can be used in site names for the site collection.

Top

See also

Reference

SPSite class

Microsoft.SharePoint namespace