SPSiteCollection Members
Include Protected Members
Include Inherited Members
Represents a collection of SPSite objects or site collections that are associated with a particular Web application, including a top-level Web site and all its sub-sites. Each SPSite object, or site collection, is represented within an SPSiteCollection objects that consists of the collection of all site collections in the Web application.
The SPSiteCollection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Count | Gets the number of SPSite objects in the collection. (Overrides SPBaseCollection.Count.) |
|
Item[Int32] | Gets the SPSite object at the specified index in the collection. In C#, this property is an indexer for the SPSiteCollection class. |
|
Item[String] | Gets the SPSite object at the specified server-relative URL in the collection. |
|
Names | Gets the server-relative URLs of all the SPSite objects in the collection. |
|
UpgradedPersistedProperties | Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.) |
|
VirtualServer | Obsolete. Gets the parent virtual server for the site collection. |
|
WebApplication | Gets the Web application in which site collections within this collection are stored. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Add(String, String, String) | Creates an SPSite object based on the specified URL and on the user name and e-mail address of the owner of the site collection. |
|
Add(String, String, String, UInt32, String, String, String, String) | Creates an SPSite object in the collection based on the specified URL, title, description, locale identifier (LCID), and site definition or site template, as well as on the user name, user display name, and e-mail address of the owner of the site collection. |
|
Add(String, String, String, UInt32, String, String, String, String, String, String, String) | Creates an SPSite object in the collection based on the specified URL, title, description, locale identifier (LCID), and site definition or site template, as well as on the user name, user display name, and e-mail address of the owner of the site collection. |
|
Add(String, String, String, UInt32, String, String, String, String, String, String, String, Boolean) | Creates an SPSite object in the collection based on the specified URL, title, description, locale identifier (LCID), and site definition or site template, as well as on the user names, user display names, and e-mail addresses of both the collection owner and a secondary contact. |
|
Add(SPSiteSubscription, String, String, String, UInt32, String, String, String, String, String, String, String, Boolean) | Creates an SPSite object in the collection based on the specified site subscription, URL, title, description, locale identifier (LCID), and site definition or site template, as well as on the user names, user display names, and e-mail addresses of both the collection owner and a secondary contact. |
|
Add(String, String, String, UInt32, String, String, String, String, String, String, String, String, String, String, String) | Creates an SPSite object in the collection based on the specified URL, title, description, locale identifier (LCID), and site definition or site template, as well as on the user names, user display names, and e-mail addresses of both the collection owner and a secondary contact, and on the database server, name for the new database, and the user name and password of the database administrator. |
|
Add(SPSiteSubscription, String, String, String, UInt32, String, String, String, String, String, String, String, String, String, String, String) | Creates an SPSite object in the collection based on the specified site subscription, URL, title, description, locale identifier (LCID), and site definition or site template, as well as on the user names, user display names, and e-mail addresses of both the collection owner and a secondary contact, and on the database server, name for the new database, and the user name and password of the database administrator. |
|
Backup | Creates a backup file for the site collection located at the specified URL. |
|
Delete(String) | Deletes the specified SPSite object from the collection. |
|
Delete(String, Boolean) | Deletes the specified SPSite object from the collection with the option of deleting Active Directory Domain Services accounts that were created for this site collection. |
|
Delete(String, Boolean, Boolean) | |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetEnumerator | (Inherited from SPBaseCollection.) |
|
GetHashCode | (Inherited from Object.) |
|
GetObjectData | Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.) |
|
GetType | (Inherited from Object.) |
|
GetTypedEnumerator<T> | (Inherited from SPBaseCollection.) |
|
MemberwiseClone | (Inherited from Object.) |
|
OnDeserialization | Called after the object has been deserialized from the file system cache or the database. (Inherited from SPAutoSerializingObject.) |
|
Restore(String, String, Boolean) | Restores the specified SPSite object to the collection. |
|
Restore(String, String, Boolean, Boolean) | Restores the specified SPSite object to the collection and specifies whether to use the host header as the name of the site collection. |
|
ToString | (Inherited from Object.) |
|
UpdateParent | Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICollection.CopyTo | (Inherited from SPBaseCollection.) |
|
IEnumerable<SPSite>.GetEnumerator | |
.gif "Private property") |
ICollection.IsSynchronized | (Inherited from SPBaseCollection.) |
|
ICollection.SyncRoot | (Inherited from SPBaseCollection.) |
Top