Метод SPWebApplication.UpdateMappedPage

Статья
05/13/2015

Обновляет сопоставления страница настраиваемого приложения.

Пространство имен: Microsoft.SharePoint.Administration
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
Public Function UpdateMappedPage ( _
    key As SPWebApplication.SPCustomPage, _
    newValue As String _
) As Boolean
'Применение
Dim instance As SPWebApplication
Dim key As SPWebApplication.SPCustomPage
Dim newValue As String
Dim returnValue As Boolean

returnValue = instance.UpdateMappedPage(key, _
    newValue)

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

Параметры

key
Тип: Microsoft.SharePoint.Administration.SPWebApplication.SPCustomPage

Страница приложения для замены указанного пользовательскую страницу приложения.

newValue
Тип: System.String

Расположение на пользовательскую страницу приложения. Это должны начинаться с «/_макеты/». Чтобы удалить сопоставление для настраиваемой страницы, значение пустая ссылка (Nothing в Visual Basic).

Возвращаемое значение

Тип: System.Boolean
true Если успешно сопоставляется на пользовательскую страницу приложения; в противном случае — false.

Замечания

Параметр newValue ограничен расположения в папку/_layouts. При обновлении сопоставленный страницы, URL-адрес должен начинаться с «/_макеты/».

Примеры

В следующем примере кода показано, как обновить сопоставления со страницы приложения AccessDenied.aspx по умолчанию для настраиваемой страницы приложений и их отображения на консоль. В конце восстанавливается на исходную страницу приложения.

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();
            }
        }
    }
}

Imports System
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Administration
Module Module1

    Sub Main()

        Using site As New SPSite("http://MyServer")
            'Get a reference to the web application.
            Dim webApp As SPWebApplication = 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()
        End Using

    End Sub

End Module

См. также

Справочные материалы

SPWebApplication класс

Элементы SPWebApplication

Пространство имен Microsoft.SharePoint.Administration

Поделиться через