SPAlternateUrlCollection Members

Include Protected Members
Include Inherited Members

Represents a collection of SPAlternateUrl objects.

The SPAlternateUrlCollection type exposes the following members.

Constructors

	Name	Description
	SPAlternateUrlCollection()	Initializes a new instance of the SPAlternateUrlCollection class.
	SPAlternateUrlCollection(String, SPFarm)	Initializes a new instance of the SPAlternateUrlCollection class based on the specified name and server farm object.

Top

Properties

	Name	Description
	CanRenameOnRestore	Gets a value that indicates whether the SPAlternateUrlCollection can be renamed when it is restored.
	CanSelectForBackup	Gets or sets a value that indicates whether the SPAlternateUrlCollection can be selected individually for a backup operation in the Central Administration user interface (UI).
	CanSelectForRestore	Gets or sets a value that indicates whether the SPAlternateUrlCollection can be selected individually for a restore operation in the Central Administration user interface (UI).
	Count	Gets the number of alternate request URLs in the collection.
	DiskSizeRequired	Gets the disk space that is required for a backup.
	DisplayName	Gets the display name of the collection. (Overrides SPPersistedObject.DisplayName.)
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	IsReadOnly	Gets a value that indicates whether the collection can be modified.
	Item[Int32]	Gets the alternate request URL object at the specified index in the collection.
	Item[String]	Gets the alternate request URL object with the specified incoming URL from the collection.
	Item[Uri]	Gets the alternate request URL object with the specified URI from the collection.
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	TypeName	Gets the localized display name of the collection, which in English is Alternate Access Mapping Collection.  (Overrides SPPersistedObject.TypeName.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	WasCreated	Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

	Name	Description
	Add	Adds the specified URL to the collection of alternate request URLs for the Web application.
	AddBackupObjects	Adds the SPAlternateUrlCollection and its children to the backup/restore operation.
	Clear	Removes all URLs from the collection, leaving the collection in an invalid state.
	Clone	Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
	Contains	Returns a value that indicates whether the specified URL is included in the collection.
	CopyTo	Copies the elements of the collection to an array of SPAlternateUrl objects, starting at a specified array index.
	Delete()	Deletes the entire collection of alternate URLs and clears local caches. (Overrides SPPersistedObject.Delete().)
	Delete(Int32)	Deletes the URL at the specified index from the collection.
	Delete(String)	Deletes the specified URL from the collection.
	Ensure	Adds an incoming URL to the collection if it does not already exist in the collection.
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Finalize	(Inherited from Object.)
	GetChild<T>()	Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
	GetChild<T>(String)	Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
	GetEnumerator	Returns an IEnumerator object that can be used to access the items in the collection.
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetResponseUrl(SPUrlZone)	Returns the appropriate URL to use when generating an outbound URL for the specified zone.
	GetResponseUrl(SPUrlZone, Boolean)	Returns the appropriate URL to use when generating an outbound URL for the specified zone. This method specifies whether to return the response URL for the Default zone if the response URL for the requested zone cannot be found.
	GetType	(Inherited from Object.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	MemberwiseClone	(Inherited from Object.)
	OnAbort	Raises the Abort (backup) event.
	OnBackup	Raises the Backup event.
	OnBackupComplete	Raises the BackupComplete event.
	OnDeserialization	Specifies that Windows SharePoint Services perform additional post-deserialization setup operations. (Overrides SPPersistedObject.OnDeserialization().)
	OnPostRestore	Raises the PostRestore event.
	OnPrepareBackup	Raises the PrepareBackup event.
	OnPreRestore	Raises the PreRestore event.
	OnRestore	Raises the Restore event.
	Provision	Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
	Remove	Deletes the specified URL from the collection if it exists in the collection, but if the URL does not exist, returns false instead of throwing an exception.
	SetRedirectUrl
	SetResponseUrl	Sets the URL to use when generating an outbound absolute URL for a particular zone.
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	Uncache	Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
	Unprovision	Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
	UnsetRedirectUrl
	UnsetResponseUrl	Removes the URL mapping that is used when generating an outbound absolute URL for a particular zone.
	Update()	Updates the collection and rebuilds lookup caches. (Overrides SPPersistedObject.Update().)
	Update(Boolean)	Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	Validate	Verifies that the alternate URL collection is in an acceptable state before calling the Update() method. (Overrides SPPersistedObject.Validate().)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerable.GetEnumerator	Returns an object that can be used to iterate through the items in the collection.

Top

See Also

Reference

SPAlternateUrlCollection Class

Microsoft.SharePoint.Administration Namespace