1 out of 1 rated this helpful - Rate this topic

SiteCollection Class

IIS 7.0

Represents a collection of Site objects.

Namespace:  Microsoft.Web.Administration
Assembly:  Microsoft.Web.Administration (in Microsoft.Web.Administration.dll)
public sealed class SiteCollection : ConfigurationElementCollectionBase<Site>

The SiteCollection type exposes the following members.

  Name Description
Public property AllowsAdd Gets a value indicating whether an add element name is defined in the current collection schema. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public property AllowsClear Gets a value indicating whether a clear element name is defined in the current collection schema. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public property AllowsRemove Gets a value indicating whether a remove element name is defined in the current collection schema. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public property Attributes Gets a configuration attribute collection that contains the list of attributes for this element. (Inherited from ConfigurationElement.)
Public property ChildElements Gets all the child elements of the current element. (Inherited from ConfigurationElement.)
Public property Count Gets the number of items in the collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public property ElementTagName Gets the XML tag name of the current element. (Inherited from ConfigurationElement.)
Public property IsLocallyStored Gets a value indicating whether the configuration element is stored in a particular configuration file. (Inherited from ConfigurationElement.)
Public property Item[([(Int32])]) Gets a configuration element at the specified index. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public property Item[([(String])]) Gets a site that has the specified name in the collection.
Public property Methods Gets a collection of methods for the configuration element. (Inherited from ConfigurationElement.)
Public property RawAttributes Gets the raw attribute names and values for the current configuration element. (Inherited from ConfigurationElement.)
Public property Schema Gets the schema that describes the configuration element collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Top
  Name Description
Public method Add(T) Adds a configuration element to the end of the current collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public method Add(String, String, Int32) Adds a new Web site to the site collection by using the specified site name, path, and binding port.
Public method Add(String, String, String, array<Byte>[]()[][]) Adds a new Web site to the site collection by using the specified site name, binding information, physical file path, and certificate hash.
Public method Add(String, String, String, String) Creates a new site by using the specified parameters and adds it to the site collection.
Public method AddAt Adds a configuration element to the current collection at the specified index. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public method Clear Clears all configuration elements from the current collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public method CreateElement()()()() Creates a new child element for the current collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public method CreateElement(String) Creates a new child element by using the specified name. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Protected method CreateNewElement Creates a new element by using the specified element name. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public method Delete (Inherited from ConfigurationElement.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetAttribute Returns a ConfigurationAttribute object that represents the requested attribute. (Inherited from ConfigurationElement.)
Public method GetAttributeValue Returns the value of the specified attribute. (Inherited from ConfigurationElement.)
Public method GetChildElement(String) Returns a child element that is under the current configuration element and has the specified name. (Inherited from ConfigurationElement.)
Public method GetChildElement(String, Type) Returns a child element that is under the current configuration element and has the specified name and type. (Inherited from ConfigurationElement.)
Public method GetCollection()()()() Returns the default collection for the current configuration element. (Inherited from ConfigurationElement.)
Public method GetCollection(String) Returns all configuration elements that belong to the current configuration element. (Inherited from ConfigurationElement.)
Public method GetCollection(Type) Returns the configuration element that has the specified type and is under the current configuration element. (Inherited from ConfigurationElement.)
Public method GetCollection(String, Type) Returns the configuration element that has the specified name and type and is under the current configuration element. (Inherited from ConfigurationElement.)
Public method GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public method GetHashCode (Inherited from Object.)
Public method GetMetadata Returns metadata values from the element schema. (Inherited from ConfigurationElement.)
Public method GetType (Inherited from Object.)
Public method IndexOf Determines the index of an element in the collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Public method Static member InvalidSiteNameCharacters Retrieves an array of characters that cannot be used in the name of a site.
Protected method MemberwiseClone (Inherited from Object.)
Public method Remove Removes the specified site from the site collection.
Public method RemoveAt Removes a Web site from the site collection at the specified collection index.
Public method SetAttributeValue Sets the value of the specified attribute. (Inherited from ConfigurationElement.)
Public method SetMetadata Sets metadata values from the element schema. (Inherited from ConfigurationElement.)
Public method ToString (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method ICollection..::..CopyTo Copies the elements of the collection to an array, starting at a particular array index. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Explicit interface implemetation Private property ICollection..::..Count Gets the number of elements in the collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Explicit interface implemetation Private method IEnumerable..::..GetEnumerator Returns an enumerator that iterates through the collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Explicit interface implemetation Private property ICollection..::..IsSynchronized Gets a value indicating whether access to the collection is synchronized (thread safe). (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Explicit interface implemetation Private property ICollection..::..SyncRoot Gets an object that is used to synchronize access to the collection. (Inherited from ConfigurationElementCollectionBase<(Of <(<'T>)>)>.)
Top

This class is sealed and does not implement a public constructor. You can access the SiteCollection class through the Sites property of the ServerManager class. SiteCollection implements the System.Collections.Generic..::..IEnumerable<(Of <(<'T>)>)> interface and includes an implementation for the GetEnumerator()()()() method. Use the Add and Remove methods, respectively, to create new sites or remove existing ones. In addition, you can use indexers to obtain a reference to an item in the collection by position or site name.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ