Настройка темы сайта SharePoint: разработка с использованием CSOM

Клиентская объектная модель (CSOM) SharePoint предоставляет доступ к объектной модели SharePoint из кода, выполняемого локально или на сервере, отличном от SharePoint.

Предварительные требования

Прежде чем приступить к работе, убедитесь, что вы знакомы с понятиями, описанными в следующих статьях:

Кроме того, необходимо сослаться на пакет NuGet Microsoft.SharePointOnline.CSOM (версия 16.0.27011.12008 или более поздняя).

Пример кода CSOM

В следующем примере показано, как создать объект Microsoft.Online.SharePoint.TenantAdministration.Tenant и вызвать метод GetAllGlobalThemes для возврата списка тем.

Примечание.

URL-адрес, используемый для создания объекта контекста, включает суффикс -admin, так как методы TenantAdministration работают с сайтом администрирования.
Создайте экземпляр объекта Tenant (Клиент) с помощью конструктора клиентов, а затем вызовите необходимые методы в этом экземпляре.
Вы можете использовать тот же подход для вызова других методов управления темами.

using System.Security;
using Microsoft.SharePoint.Client;
using Microsoft.Online.SharePoint.TenantAdministration;
using Microsoft.Online.SharePoint.TenantManagement;

...

ClientContext ctx = new ClientContext("https://mysite-admin.sharepoint.com/");
var pwd = "mypassword";
var passWord = new SecureString();
foreach (char c in pwd.ToCharArray()) passWord.AppendChar(c);
ctx.Credentials = new SharePointOnlineCredentials("admin@mydomain.com", passWord);
Tenant tenant = new Tenant(ctx);
ClientObjectList<ThemeProperties> themes = tenant.GetAllGlobalThemes();

Пример определения темы

Для методов, принимающих тему в качестве аргумента, приведенный ниже код определяет класс SPOTheme, используемый для создания настраиваемых тем. Для нового формата темы требуются только Name свойства и ColorPairs . Для устаревшего формата Nameтемы требуются свойства , Paletteи IsInverted .

/// <summary> 
/// Properties defining a theme in SharePoint Online. 
/// </summary> 
public class SPOTheme 
{ 
    /// <summary> 
    /// Specifies the name of the theme. This must uniquely identify the theme. 
    /// </summary> 
    public string Name 
    { 
        get; private set; 
    } 
    /// <summary> 
    /// Specifies the palette of colors in the theme, as a dictionary of theme slot values. 
    /// </summary> 
    public IDictionary<String, String> Palette 
    { 
        get; private set; 
    } 
    /// <summary> 
    /// Specifies the color pairs setting of the theme.
    /// </summary> 
    public IDictionary<string, IList<Dictionary<string, string>>> ColorPairs
    { 
        get; private set; 
    } 
    /// <summary> 
    /// Specifies whether the theme is inverted, with a dark background and a light foreground. 
    /// </summary> 
    public bool IsInverted 
    { 
        get; private set; 
    } 
}

Применение темы

На данный момент нет поддерживаемых API CSOM для программного применения темы к определенному сайту. Сведения о применении пользовательских тем к отдельным семействам веб-сайтов см. в статье Обзор макетов и скриптов сайтов SharePoint

Методы и свойства класса Microsoft.Online.SharePoint.TenantAdministration.Tenant

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

Открытый метод AddTenantThemeAdvanced

Добавьте тему в организацию.

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

Пространство имен: Microsoft.Online.SharePoint.TenantAdministration.Tenant.
Параметры: имя строки, строка themeJson, bool shouldParseColorPair
Тип возвращаемого значения: Bool ClientResult<>

Открытый метод UpdateTenantThemeAdvanced

Обновляет параметры имеющейся темы.

Общедоступный метод AddTenantTheme

Добавьте тему в организацию. Этот метод не поддерживается для администраторов в вспомогательных географических регионах.

Пространство имен: Microsoft.Online.SharePoint.TenantAdministration.Tenant.
Параметры: string name, string themeJson.
Тип возвращаемого значения: Bool ClientResult<>

Общедоступный метод UpdateTenantTheme

Обновляет параметры имеющейся темы.

Общедоступный метод DeleteTenantTheme

Удаляет тему из клиента.

Пространство имен: Microsoft.Online.SharePoint.TenantAdministration.Tenant.
Параметры: string name.
Тип возвращаемых данных: void.

Открытый метод GetAllGlobalThemes

Получите полный набор пользовательских тем, определенных на уровне клиента, включая темы, созданные с помощью командных средств, и темы, созданные в пользовательском интерфейсе Центра фирменной символики.

Примечание.

Для поддержки согласованной фирменной символики и упрощения управления управление темами переходит на централизованную модель.

Основной географический регион будет выступать в качестве центрального расположения для создания темы и управления ими в масштабах всей организации. Темы, созданные здесь, будут видны и применимы в спутниковых географических регионах.
Вспомогательные геоадминистрации смогут просматривать темы из основного географического региона на собственные сайты с помощью GetAllGlobalThemes метода . Темы, ранее созданные в пределах спутниковых геопространств, останутся доступными для использования. Однако создание новых тем в спутниковых геопространствах больше не будет поддерживаться в будущем.

Пространство имен: Microsoft.Online.SharePoint.TenantAdministration.Tenant.
Параметры: нет.
Тип возвращаемого значения: Тема ClientObjectListProperties<>

Общедоступный метод GetAllTenantThemes

Получите все пользовательские темы, созданные в текущем клиенте, с помощью командных средств.

Общедоступный метод GetGlobalTheme

Получите тему по имени, включая темы, созданные с помощью командных средств, и темы, созданные в пользовательском интерфейсе Центра фирменной символики.

Пространство имен: Microsoft.Online.SharePoint.TenantAdministration.Tenant.
Параметры: string name.
Тип возвращаемых данных: ThemeProperties.

Общедоступный метод GetTenantTheme

Получает тему по имени.