Share via


SPAlternateUrlCollectionManager Class

Provides methods that can be used to perform operations on all the SPAlternateUrlCollection objects in the farm.

Inheritance Hierarchy

System.Object
  Microsoft.SharePoint.Administration.SPPersistedObjectCollection<SPAlternateUrlCollection>
    Microsoft.SharePoint.Administration.SPPersistedChildCollection<SPAlternateUrlCollection>
      Microsoft.SharePoint.Administration.SPAlternateUrlCollectionManager

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
Public NotInheritable Class SPAlternateUrlCollectionManager _
    Inherits SPPersistedChildCollection(Of SPAlternateUrlCollection) _
    Implements IEnumerable(Of SPAlternateUrlCollection), IEnumerable(Of SPAlternateUrl),  _
    IEnumerable
'Usage
Dim instance As SPAlternateUrlCollectionManager
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
public sealed class SPAlternateUrlCollectionManager : SPPersistedChildCollection<SPAlternateUrlCollection>, 
    IEnumerable<SPAlternateUrlCollection>, IEnumerable<SPAlternateUrl>, IEnumerable

Remarks

Use the SPFarm.AlternateUrlCollections property to return the SPAlternateUrlCollectionManager object for the server farm.

Examples

The following example verifies that the RebaseUriWithAlternateUri method converts a specified incoming URL to the default zone outgoing URL.

Dim altUrlCollection As SPAlternateUrlCollection = SPContext.Current.Site.WebApplication.AlternateUrls

Dim altUrlCollectionMgr As SPAlternateUrlCollectionManager = SPFarm.Local.AlternateUrlCollections

Dim incomingUri As New Uri("http://MyIncomingUrl")

Dim responseUri As Uri = altUrlCollectionMgr.RebaseUriWithAlternateUri(incomingUri, SPUrlZone.Default)

If responseUri = altUrlCollection.GetResponseUrl(SPUrlZone.Default).Uri Then
    Response.Write("Incoming URI converted to default outgoing URL.")
End If
SPAlternateUrlCollection altUrlCollection = SPContext.Current.Site.WebApplication.AlternateUrls;

SPAlternateUrlCollectionManager altUrlCollectionMgr = SPFarm.Local.AlternateUrlCollections;

Uri incomingUri = new Uri("http://MyIncomingUrl");

Uri responseUri = altUrlCollectionMgr.RebaseUriWithAlternateUri(incomingUri, SPUrlZone.Default);

if (responseUri == altUrlCollection.GetResponseUrl(SPUrlZone.Default).Uri)
{
    Response.Write("Incoming URI converted to default outgoing URL.");
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

SPAlternateUrlCollectionManager Members

Microsoft.SharePoint.Administration Namespace