SharePoint-Websitedesign: CSOM-Entwicklung

Das clientseitige SharePoint-Objektmodell (Client-Side Object Model, CSOM) bietet Zugriff auf das SharePoint-Objektmodell von Code, der lokal oder auf einem anderen Server als SharePoint ausgeführt wird.

Voraussetzungen

Machen Sie sich mit den folgenden Themen vertraut, bevor Sie mit den ersten Schritten beginnen:

Außerdem müssen Sie auf das NuGet-Paket Microsoft.SharePointOnline.CSOM verweisen (Version 16.0.27011.12008 oder höher).

CSOM-Codebeispiel

Das folgende Beispiel zeigt, wie Sie ein Microsoft.Online.SharePoint.TenantAdministration.Tenant-Objekt erstellen und die GetAllGlobalThemes-Methode aufrufen, um eine Liste von Designs zurückzugeben.

Hinweis

Die URL zum Erstellen des Kontextobjekts enthält das Suffix -admin, da TenantAdministration-Methoden mit der Adminwebsite funktionieren.
Erstellen Sie eine Tenant-Instanz mit dem Tenant-Konstruktor, und rufen Sie dann die Methoden für diese Instanz auf.
Die können den gleichen Ansatz zum Aufrufen anderer Methoden für die Designverwaltung verwenden.

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

Beispiel für Designdefinition

Bei Methoden, die ein Designargument akzeptieren, definiert der folgende Code eine SPOTheme-Klasse, die Sie zum Erstellen von benutzerdefinierten Designs verwenden können. Für das neue Designformat sind nur die Name Eigenschaften und ColorPairs erforderlich. Für das Legacydesignformat sind die NameEigenschaften , Paletteund IsInverted erforderlich.

/// <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; 
    } 
}

Anwenden eines Designs

Es ist aktuell keine unterstützte CSOM-API zum programmgesteuerten Anwenden eines Designs auf eine spezielle Website vorhanden. Informationen zum Anwenden von benutzerdefinierten Designs auf einzelne Websitesammlungen finden Sie unter SharePoint-Website Entwurf und Website-Skript (Übersicht).

Methoden/Eigenschaften der Klasse „Microsoft.Online.SharePoint.TenantAdministration.Tenant“

Verwenden Sie die folgenden Methoden, um die Gruppe der verfügbaren Designs für eine SharePoint-Mandantenverwaltungswebsite anzupassen. Sie können ein neues benutzerdefiniertes Design hinzufügen, ein vorhandenes Design aktualisieren oder ein Design löschen und ein bestimmtes Design oder alle Designs abrufen. Sie können auch die Standarddesigns ausblenden oder wiederherstellen, die SharePoint bereitstellt.

AddTenantThemeAdvanced öffentliche Methode

Fügen Sie dem organization ein Design hinzu.

In Multi-Geo-Umgebungen werden Designs, die von einem Administrator in der primären Geografie hinzugefügt wurden, automatisch verteilt und über die organization verfügbar. Diese Methode wird für Administratoren in Satellitenregionen nicht unterstützt.

Namespace: Microsoft.Online.SharePoint.TenantAdministration.Tenant
Parameter: Zeichenfolgenname, ZeichenfolgendesignJson, bool shouldParseColorPair
Rückgabetyp: ClientResult<bool>

Öffentliche UpdateTenantThemeAdvanced-Methode

Aktualisieren Sie die Einstellungen für ein vorhandenes Design.

Namespace: Microsoft.Online.SharePoint.TenantAdministration.Tenant
Parameter: Zeichenfolgenname, ZeichenfolgendesignJson, bool shouldParseColorPair
Rückgabetyp: ClientResult<bool>

Öffentliche Methode „AddTenantTheme“

Fügen Sie dem organization ein Design hinzu. Diese Methode wird für Administratoren in Satellitenregionen nicht unterstützt.

Namespace: Microsoft.Online.SharePoint.TenantAdministration.Tenant
Parameter: string name, string themeJson
Rückgabetyp: ClientResult<bool>

Öffentliche Methode „UpdateTenantTheme“

Aktualisieren Sie die Einstellungen für ein vorhandenes Design.

Namespace: Microsoft.Online.SharePoint.TenantAdministration.Tenant
Parameter: string name, string themeJson
Rückgabetyp: ClientResult<bool>

Öffentliche Methode „DeleteTenantTheme“

Löschen Sie ein Design aus dem Mandanten.

Namespace: Microsoft.Online.SharePoint.TenantAdministration.Tenant
Parameter: string name
Rückgabetyp: void

Öffentliche GetAllGlobalThemes-Methode

Rufen Sie den vollständigen Satz von benutzerdefinierten Designs ab, die auf Mandantenebene definiert sind, einschließlich der Designs, die über befehlsbasierte Tools erstellt wurden, und die designs, die auf der Brand Center-Benutzeroberfläche erstellt wurden.

Hinweis

Um ein konsistentes Branding zu unterstützen und die Governance zu vereinfachen, wird die Designverwaltung auf ein zentralisiertes Modell umgestellt.

Der primäre geografische Standort fungiert als zentraler Ort für organization-weite Designerstellung und -verwaltung. Designs, die hier erstellt werden, sind sichtbar und können über satellitenübergreifende Geografische Regionen hinweg angewendet werden.
Die Satelliten-Geoadministratoren können Designs vom primären geografischen Standort bis zu ihren eigenen Websites mithilfe GetAllGlobalThemes der -Methode anzeigen. Designs, die zuvor in Satelliten-Geos erstellt wurden, bleiben zur Verwendung verfügbar. Das Erstellen neuer Designs in Satellitengeografien wird jedoch in Zukunft nicht mehr unterstützt .

Namespace: Microsoft.Online.SharePoint.TenantAdministration.Tenant
Parameter: none
Rückgabetyp: ClientObjectList<ThemeProperties>

Öffentliche Methode „GetAllTenantThemes“

Rufen Sie alle benutzerdefinierten Designs ab, die auf dem aktuellen Mandanten über befehlsbasierte Tools erstellt werden.

Namespace: Microsoft.Online.SharePoint.TenantAdministration.Tenant
Parameter: none
Rückgabetyp: ClientObjectList<ThemeProperties>

Öffentliche GetGlobalTheme-Methode

Rufen Sie ein Design anhand des Namens ab, einschließlich Designs, die über befehlsbasierte Tools erstellt wurden, und solche, die auf der Brand Center-Benutzeroberfläche erstellt wurden.

Namespace: Microsoft.Online.SharePoint.TenantAdministration.Tenant
Parameter: string name
Rückgabetyp: ThemeProperties

Öffentliche Methode „GetTenantTheme“

Rufen Sie ein Design anhand des Namens ab.