Export (0) Print
Expand All

SPSite Members

Windows SharePoint Services 3

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.

  NameDescription
Public method SPSite(Guid) Initializes a new instance of the SPSite class based on the specified GUID for a site collection and the default URL zone (SPUrlZone.Default).
Public method SPSite(String) Initializes a new instance of the SPSite class based on the specified absolute URL.
Public method SPSite(Guid, SPUrlZone) Initializes a new instance of the SPSite class based on the specified site collection GUID and URL zone.
Public method SPSite(Guid, SPUserToken) Initializes a new instance of the SPSite class based on the specified site collection GUID and user token.
Public method SPSite(String, SPUserToken) Initializes a new instance of the SPSite class based on the specified absolute URL and user token.
Public method 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

  NameDescription
Public property AllowRssFeeds Gets a Boolean value that specifies whether the site collection allows RSS feeds.
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 Audit Gets an audit store that is attached to the site collection.
Public property CatchAccessDeniedException Infrastructure. Use the CatchAccessDeniedException property instead to specify whether Windows SharePoint Services 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 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 DeadWebNotificationCount Gets the number of notifications that have been sent about Web sites within the site collection that are out of use.
Public property ExternalBinaryIds Gets an SPExternalBinaryIdCollection object that is used to retrieve the IDs of external binary large object (BLOB) files that are contained in the external BLOB store provider (EBS Provider).
Public property Features Gets the collection of SPFeature objects that are associated with the site collection.
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 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 IsPaired Gets a Boolean value that indicates whether the site collection is paired with its parent.
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 Owner Gets or sets the owner of the site collection.
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.
Public property PortalUrl Gets or sets the URL to a portal.
Public property Protocol Gets the protocol, HTTP or HTTPS, that is used by the server.
Public property Quota Gets or sets a quota for the site collection.
Public property ReadLocked Gets or sets a Boolean value that specifies whether the site collection is locked and unavailable for Read access.
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 RootWeb Gets the root Web site of the 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.
Public property ServerRelativeUrl Gets the server-relative URL of the root Web site in the 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 UpgradeRedirectUri Gets an object representation of the upgrade redirect uniform resource identifier (URI) of the site collection.
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 Gets or sets the provider-specific user account directory path for the site collection.
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 parent SharePoint Web application for the site collection.
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

  NameDescription
Public method AddWorkItem Adds a work item to the site collection.
Public method BypassUseRemoteApis Bypasses using SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the site collection.
Public method CheckForPermissions Checks the permissions for a given set of rights and throws an Unauthorized Access exception if the permission check fails.
Public method Close Closes the site collection and releases resources.
Public method ConfirmUsage Certifies that the site collection is in use.
Public method Delete() Deletes the site collection from the server.
Public method 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.
Public method Dispose Releases all unmanaged resources that are used by the site collection object.
Public method DoesUserHavePermissions(SPReusableAcl, SPBasePermissions) Returns a Boolean value indicates whether the user has permissions for the specified set of rights.
Public method DoesUserHavePermissions(SPReusableAcl, SPBasePermissions, SPWeb) Returns a Boolean value that indicates whether the user has permissions for the specified Web site and set of rights.
Public method Equals (Inherited from Object.)
Public method Static member Exists Returns a Boolean value that indicates whether the specified site collection exists.
Protected method Finalize (Inherited from Object.)
Public method GetAllReusableAcls() Returns the reusable access control lists (ACLs) for the site collection.
Public method GetAllReusableAcls(Int32) Returns the reusable access control lists (ACLs) of the site collection up to a specified limit.
Public method 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.
Public method GetChanges() Returns the first 1000 changes listed in the current change log for the site collection.
Public method GetChanges(SPChangeQuery) Returns a collection of changes from the change log filtered by the specified query.
Public method GetChanges(SPChangeToken) Returns a collection of changes, starting from a particular point in the change log.
Public method GetChanges(SPChangeToken, SPChangeToken) Returns a collection of changes that have been logged over a specified period of time.
Public method GetCustomListTemplates Returns the collection of custom list templates, which are created by end users, from the specified site.
Public method GetCustomWebTemplates Returns the collection of site templates for the site collection based on the specified locale ID (LCID).
Public method GetEffectiveRightsForAcl(SPReusableAcl) Returns the actual permissions that the current user has for the specified Access Control List (ACL).
Public method GetEffectiveRightsForAcl(SPReusableAcl, SPWeb) Returns the actual permissions that the current user has for the specified access control list (ACL).
Public method GetHashCode (Inherited from Object.)
Public method GetRecycleBinItems Returns a collection of recycle bin items based on the specified query.
Public method GetRecycleBinStatistics Returns the number of items in the recycle bin and its size as output parameters.
Public method GetReusableAclForScope Returns the reusable access control list (ACL) for the specified scope.
Public method GetSelfServiceSiteCreationSettings Returns the settings that are used for Self-Service Site Creation.
Public method GetType (Inherited from Object.)
Public method GetWebTemplates Returns the collection of site definitions that are available for creating Web sites within the site collection.
Public method GetWorkItems Returns the individual work items, number of columns, and number of rows in the specified work item collection as output parameters.
Public method Static member InvalidateCacheEntry Removes the specified cache entry and returns a Boolean value that indicates whether the entry was cached.
Public method Static member LookupUriInRemoteFarm Returns the Uniform Resource Identifier (URI) of a Web site in the specified remote server farm.
Public method MakeFullUrl Returns the full URL for the specified server-relative URL.
Protected method MemberwiseClone (Inherited from Object.)
Public method OpenWeb() Returns the site that is associated with the URL that is used in an SPSite constructor.
Public method OpenWeb(Guid) Returns the site with the specified GUID.
Public method OpenWeb(String) Returns the site that is located at the specified server-relative or site-relative URL.
Public method OpenWeb(String, Boolean) Returns the 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.
Public method RecalculateStorageUsed Recalculates the storage that is used by the site collection.
Public method RefreshEmailEnabledObjects Refreshes the e-mailed–enabled objects of the site collection.
Public method Rename Changes the URL of a host-header-named site collection to a new URL.
Public method SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String) Creates a site collection by using Self-Service Site Creation.
Public method 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.
Public method StorageManagementInformation Returns information about storage management for the site collection.
Public method ToString Returns the name of the site collection. (Overrides Object.ToString().)
Public method UpdateValidationKey Updates the key that is used to generate the form digest validation of the site collection.
Public method Static member ValidateDomainCompatibility Verifies whether two URLs point to the same site collection, even if the domain portions of the URLs are different.
Top

  NameDescription
Public field Static member MaxFullUrlLength Represents the maximum number of characters that can be used in the absolute URL for a site collection.
Public field Static member MaxWebNameLength Represents the maximum number of characters that can be used in site names for the site collection.
Top

Community Additions

ADD
Show:
© 2014 Microsoft