SPAlternateUrlCollection members

  • Article

Represents a collection of SPAlternateUrl objects.

The SPAlternateUrlCollection type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property CanRenameOnRestore Gets a value that indicates whether the SPAlternateUrlCollection can be renamed when it is restored.
Public property 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).
Public property 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).
Public property Count Gets the number of alternate request URLs in the collection.
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property DiskSizeRequired Gets the disk space that is required for a backup.
Public property DisplayName Gets the display name of the collection. (Overrides SPPersistedObject.DisplayName.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property IsReadOnly Gets a value that indicates whether the collection can be modified.
Public property Item[Int32] Gets the alternate request URL object at the specified index in the collection.
Public property Item[String] Gets the alternate request URL object with the specified incoming URL from the collection.
Public property Item[Uri] Gets the alternate request URL object with the specified URI from the collection.
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Gets the localized display name of the collection, which in English is Alternate Access Mapping Collection.  (Overrides SPPersistedObject.TypeName.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property 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
Public method Add Adds the specified URL to the collection of alternate request URLs for the Web application.
Public method AddBackupObjects Adds the SPAlternateUrlCollection and its children to the backup/restore operation.
Public method Clear Removes all URLs from the collection, leaving the collection in an invalid state.
Public method 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.)
Public method Contains Returns a value that indicates whether the specified URL is included in the collection.
Public method CopyTo Copies the elements of the collection to an array of SPAlternateUrl objects, starting at a specified array index.
Public method Delete() Deletes the entire collection of alternate URLs and clears local caches. (Overrides SPPersistedObject.Delete().)
Public method Delete(Int32) Deletes the URL at the specified index from the collection.
Public method Delete(String) Deletes the specified URL from the collection.
Public method Ensure Adds an incoming URL to the collection if it does not already exist in the collection.
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetEnumerator Returns an IEnumerator object that can be used to access the items in the collection.
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetResponseUrl(SPUrlZone) Returns the appropriate URL to use when generating an outbound URL for the specified zone.
Public method 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. 
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAbort Raises the Abort (backup) event.
Public method OnBackup Raises the Backup event.
Public method OnBackupComplete Raises the BackupComplete event.
Protected method OnDeserialization Specifies that Windows SharePoint Services perform additional post-deserialization setup operations. (Overrides SPPersistedObject.OnDeserialization().)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Public method OnPostRestore Raises the PostRestore event.
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method OnPrepareBackup Raises the PrepareBackup event.
Public method OnPreRestore Raises the PreRestore event.
Public method OnRestore Raises the Restore event.
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method 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. 
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method SetRedirectUrl Sets the url that will be used when generating an redirect absolute url for a particular zone during gradual upgrade.
Public method SetResponseUrl Sets the URL to use when generating an outbound absolute URL for a particular zone.
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method UnsetRedirectUrl Remove the redirect url from this zone
Public method UnsetResponseUrl Removes the URL mapping that is used when generating an outbound absolute URL for a particular zone.
Public method Update() Updates the collection and rebuilds lookup caches. (Overrides SPPersistedObject.Update().)
Public method 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.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Protected method 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
Explicit interface implemetationPrivate method 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