Export (0) Print
Expand All

SPWebApplication.UpdateMappedPage Method

Updates the custom application page mapping.

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

public bool UpdateMappedPage(
	SPWebApplication.SPCustomPage key,
	string newValue
)

Parameters

key
Type: Microsoft.SharePoint.Administration.SPWebApplication.SPCustomPage

The application page to replace with the specified custom application page.

newValue
Type: System.String

The location of the custom application page. This must start with “/_layouts/”. To remove the mapping to the custom page, set the value to a null reference (Nothing in Visual Basic).

Return Value

Type: System.Boolean
true if the custom application page is successfully mapped; otherwise, false.

The newValue parameter is restricted to a location in the /_layouts folder. When updating the mapped page, the URL has to start with “/_layouts/”.

The following code sample shows how to update the mapping from the default AccessDenied.aspx application page to a custom application page and display it to the console. The original application page is restored at the end.


using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Administration;

namespace MapCustomAppPage
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("http://MyServer"))
            {
                //Get a reference to the web application.
                SPWebApplication webApp = site.WebApplication;

                //Update AccessDenied application page to AxsDnd.aspx.
                webApp.UpdateMappedPage(SPWebApplication.SPCustomPage.AccessDenied, "/_layouts/SubFolder/AxsDnd.aspx");
                webApp.Update();

                //Output the newly assigned application page.
                Console.Out.WriteLine(webApp.GetMappedPage(SPWebApplication.SPCustomPage.AccessDenied));

                //Reset the mapping to the default application page.
                webApp.UpdateMappedPage(SPWebApplication.SPCustomPage.AccessDenied, null);
                webApp.Update();

                Console.Out.WriteLine("Press any key...");
                Console.ReadKey();
            }
        }
    }
}

Show:
© 2015 Microsoft