Konfigurationsoptionen für die Seitentransformation

Wenn Sie das Seitentransformations-Framework verwenden, können Sie genau steuern, wie die Seitentransformation abläuft. Das Modell, um dies zu steuern, besteht darin, die richtige Konfiguration als Teil der PageTransformationInformation -Instanz für Wiki- und Webpartseiten oder eine PublishingPageTransformationInformation Instanz für Veröffentlichungsseiten anzugeben. Die erstellte Transformationsinstanz wird verwendet, um die Seitentransformation zu starten. In diesem Artikel erfahren Sie mehr über die verfügbaren Optionen.

Wichtig

SharePoint PnP Modernization ist ein Bestandteil des PnP-Framework und wird ständig weiterentwickelt. Sehen Sie sich die Versionshinweise an, um bezüglich der aktuellsten Änderungen auf dem neuesten Stand zu bleiben. Wenn Sie Probleme feststellen, öffnen Sie bitte ein Ticket in der GitHub-Problemliste im PnP-Framework.

Overwrite-Option

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Wenn Sie Overwrite = true konfigurieren, wird die Zielseite vom Seitentransformations-Framework überschrieben, falls erforderlich. Standardmäßig weist der Name der neuen Seite das Präfix „Migrated_“ auf, was dann impliziert, dass es überschrieben wird, wenn Migrated_IhreSeite.aspx bereits vorhanden ist. Der folgende Codeausschnitt zeigt, wie diese Option verwendet wird.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    Overwrite = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    Overwrite = true,
};

SourcePage-Option

Typ	Standardwert, wenn nicht angegeben
ListItem	null

Wird in der Regel über den Konstruktor festgelegt, wie im folgenden Beispiel gezeigt. Dies gibt die Seite an, die modernisiert werden soll, wenn die Seite in einer Liste enthalten ist.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    Overwrite = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    Overwrite = true,
};

Option "SourceFile" (ab Version von Juni 2019)

Typ	Standardwert, wenn nicht angegeben
Datei	null

Wird verwendet, um eine Seite zu definieren, die modernisiert werden soll, wenn sich die Seite außerhalb einer Liste befindet, also im Stammordner der Website. Diese Seiten können nur Webpartseiten sein.

var fileToModernize = cc.Web.GetFileByServerRelativeUrl("/sites/myspecialsite/default.aspx");
cc.Load(fileToModernize);
cc.ExecuteQueryRetry();

PageTransformationInformation pti = new PageTransformationInformation(null)
{
    SourceFile = true,
};

TargetPagePrefix-Option

Typ	Standardwert, wenn nicht angegeben
Zeichenfolge	Migrated_

Die neue moderne Seite heißt {TargetPagePrefix} {OriginalPageName} (z. B. Migrated_MeineSeite.aspx). Wenn Sie ein anderes Präfix verwenden möchten, verwenden Sie diese Option.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    TargetPagePrefix = "New_",
};

Hinweis

Diese Option ist für die Veröffentlichungsseitentransformation nicht verfügbar.

TargetPageTakesSourcePageName-Option

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Das Standardverhalten besteht darin, der erstellten modernen Seite einen Namen zu geben, der mit dem Präfix „Migrated_“ beginnt, und den vorhandenen Namen der ursprünglichen Seite beizubehalten. Wenn diese Option angegeben wird, erhält die neu erstellte Seite den Namen der ursprünglichen Seite, und der ursprünglichen Seite wird das Präfix „Previous_“ vorangestellt. Legen Sie diese Option fest, wenn Sie sicher sind, dass Sie mit der modernen Seite fortfahren möchten, da dadurch sichergestellt wird, dass alle Links, die auf die ursprüngliche Seite zeigen, jetzt dazu führen, dass die neue moderne Seite geladen wird.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    TargetPageTakesSourcePageName = true,
};

Wichtig

Während der Umbenennung der ursprünglichen Seite in eine Seite, die mit dem Präfix „Previous_“ beginnt, wird der Versionsverlauf der ursprünglichen Seite nicht beibehalten.

Hinweis

Diese Option ist für die Veröffentlichungsseitentransformation nicht verfügbar.

SourcePagePrefix-Option

Typ	Standardwert, wenn nicht angegeben
Zeichenfolge	Previous_

Wenn Sie TargetPageTakesSourcePageName = true festgelegt haben, wird der ursprünglichen Seite das Standardpräfix „Previous_“ vorangestellt. Wenn Sie ein anderes Präfix verwenden möchten, verwenden Sie diese Option.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    SourcePagePrefix = "Old_",
};

Hinweis

Diese Option ist für die Veröffentlichungsseitentransformation nicht verfügbar.

TargetPageName-Option

Typ	Standardwert, wenn nicht angegeben
Zeichenfolge	leer

Optional können Sie den Seitennamen der Zielseite überschreiben. Standardmäßig generiert die Seitentransformations-Engine eine, aber manchmal muss sie überschrieben werden (z. B. kollidiert default.aspx mit der Ansichtsseite default.aspx der SitePages-Bibliothek).

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    TargetPageName = "mypage.aspx",
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    TargetPageName = "mypage.aspx",
};

TargetPageFolder-Option (ab Version von November 2019)

Typ	Standardwert, wenn nicht angegeben
Zeichenfolge	leer

Optional können Sie den Ordner angeben, in dem die Zielseite erstellt wird. Beachten Sie, dass, wenn ein Ordner automatisch erstellt wurde (z. B. weil Sie aus einer zusätzlichen Wiki-Seitenbibliothek transformiert haben), der durch diesen Parameter angegebene Ordner mit dem automatisch generierten Ordner kombiniert wird (es sei denn, Sie verwenden ebenfalls die TargetPageFolderOverridesDefaultFolder Option). Sie können einen Ordner wie den folgenden angeben: MyFolder oder MyFolder/SubFolder, wenn Sie eine geschachtelte Ordnerstruktur erstellen möchten. Wenn Sie als Wert angeben <root> , können Sie den Stamm der Zielbibliothek für sitepages als Ziel festlegen (ab Version von Januar 2020).

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    TargetPageFolder = "MyFolder",
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    TargetPageFolder = "MyFolder",
};

TargetPageFolderOverridesDefaultFolder-Option (ab Version von Dezember 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Sie können die Seitentransformation erzwingen, um den über die TargetPageFolder -Eigenschaft angegebenen Ordner zu verwenden, unabhängig davon, ob ein automatisch erstellter Ordner vorhanden ist oder nicht.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    TargetPageFolderOverridesDefaultFolder = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    TargetPageFolderOverridesDefaultFolder = true,
};

ReplaceHomePageWithDefaultHomePage-Option

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Das Standardverhalten besteht darin, die Startseite Ihrer Website wie alle anderen regulären Seiten in eine moderne Seite zu transformieren. Wenn Sie diese Option auf „true“ festlegen, wird die Startseite Ihrer Website auf die standardmäßig bereitgestellte Startseite zurückgesetzt, d. h. Sie erhalten dieselbe Seite, die Sie bekommen würden, wenn Sie eine moderne Teamwebsite ganz neu erstellen würden.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    ReplaceHomePageWithDefaultHomePage = true,
};

Hinweis

Diese Option ist für die Veröffentlichungsseitentransformation nicht verfügbar.

KeepPageSpecificPermissions-Option

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	true

Das Standardverhalten besteht darin, alle Berechtigungen auf Elementebene zu kopieren, die möglicherweise in der Quellseite vorhanden sind. Wenn Sie dies nicht möchten, legen Sie diese Option auf „false“ fest.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    KeepPageSpecificPermissions = false,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    KeepPageSpecificPermissions = false,
};

CopyPageMetadata-Option (ab Version von Februar 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Wenn Sie Ihre Wiki-Seitenbibliothek um zusätzliche Spalten zum Sammeln von Seitenmetadaten erweitert haben und diese Metadaten auf die erstellte moderne Seite kopieren möchten, legen Sie diese Option auf true fest.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    CopyPageMetadata = true,
};

Hinweis

Diese Option ist für die Veröffentlichungsseitentransformation nicht verfügbar. Verwenden Sie das Layoutzuordnungsmodell für Veröffentlichungsseiten, um zu definieren, ob Metadaten kopiert werden müssen und wie dies geschehen muss.

Hinweis

Ab dem Release vom Oktober 2019 funktioniert das Kopieren von Seitenmetadaten auch dann, wenn Sie eine websiteübergreifende Transformation durchführen, wenn Sie also die moderne Seite in einer anderen Websitesammlung als der ursprünglichen Quellseite erstellen.

RemoveEmptySectionsAndColumns-Option (ab Version von März 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	true

Das Standardverhalten besteht darin, alle leeren Abschnitte und Spalten zu entfernen (z. B. wenn Sie aus einem Layout mit drei Spalten transformieren und nur ein Webpart in der mittleren Spalte haben), da dies zu einer besseren Verwendung der Bildschirmumgebung führt. Wenn Sie dies nicht möchten, legen Sie diese Option auf false fest.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    RemoveEmptySectionsAndColumns = false,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    RemoveEmptySectionsAndColumns = false,
};

MappingProperties-Wörterbuch (ab Version von März 2019)

Typ	Standardwert, wenn nicht angegeben
Wörterbuchzeichenfolge,Zeichenfolge<>	leer

Die Standardzuordnungsdatei kann durch Festlegen von Zuordnungseigenschaften konfiguriert werden.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    // If target page exists, then overwrite it
    Overwrite = true,
};

pti.MappingProperties["SummaryLinksToQuickLinks"] = "false";

pageTransformator.Transform(pti);

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    // If target page exists, then overwrite it
    Overwrite = true,
};

pti.MappingProperties["SummaryLinksToQuickLinks"] = "false";

pageTransformator.Transform(pti);

Option "PublishCreatedPage" (ab Version vom April 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	true

Das Standardverhalten besteht darin, die erstellte moderne Seite zu veröffentlichen. Verwenden Sie diese Option, wenn Sie dies verhindern möchten.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    PublishCreatedPage = false,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    PublishCreatedPage = false,
};

KeepPageCreationModificationInformation-Option (ab Version von Oktober 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Das Standardverhalten besteht darin, den Autor, den Editor, die Erstellung von Daten und das Änderungsdatum der Quellseite nicht beizubehalten. Verwenden Sie diese Option, um dies zu ändern.

Hinweis

Diese Option funktioniert nur, wenn sich die Quellseite im selben SPO-Mandanten wie das Ziel der modernen Seite befindet.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    KeepPageCreationModificationInformation = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    KeepPageCreationModificationInformation = true,
};

Option "PostAsNews" (ab Veröffentlichung von Oktober 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Posten Sie die erstellte Seite als News. Dies bedeutet, dass die Seite auch veröffentlicht wird, auch wenn Sie die verwendet haben, um die PublishCreatedPage Seitenveröffentlichung zu verhindern.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    PostAsNews = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    PostAsNews = true,
};

DisablePageComments-Option (ab version april 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Das Standardverhalten besteht darin, Seitenkommentare aktiviert zu lassen. Verwenden Sie diese Option, wenn Sie eine Seite mit deaktivierten Seitenkommentaren erstellen möchten.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    DisablePageComments = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    DisablePageComments = true,
};

SkipUrlRewrite-Option (ab Version mai 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Das Standardverhalten besteht darin, das URL-Umschreiben aktiviert zu lassen. Verwenden Sie diese Option, wenn Sie eine Seite mit deaktiviertem URL-Umschreiben erstellen möchten. Weitere Informationen hierzu finden Sie im Artikel URL-Zuordnung.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    SkipUrlRewrite = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    SkipUrlRewrite = true,
};

UrlMappingFile-Option (ab Version von Juli 2019)

Typ	Standardwert, wenn nicht angegeben
Zeichenfolge	leer

Optional können Sie eine Datei mit benutzerdefinierten URL-Zuordnungen angeben. Weitere Informationen hierzu finden Sie im Artikel URL-Zuordnung.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    UrlMappingFile = @"c:\temp\urlmappingfile.csv",
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    UrlMappingFile = @"c:\temp\urlmappingfile.csv",
};

SkipDefaultUrlRewrite-Option (ab September 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Das Standardverhalten besteht darin, das Umschreiben von Standard-URLs durchzuführen. Falls Sie eine benutzerdefinierte URL-Zuordnungsdatei verwenden und nicht die Standardlogik für das Erneute Generieren von URLs anwenden möchten, legen Sie diese Eigenschaft fest. Weitere Informationen hierzu finden Sie im Artikel URL-Zuordnung.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    SkipDefaultUrlRewrite = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    SkipDefaultUrlRewrite = true,
};

AddTableListImageAsImageAsImageWebPart-Option (ab Version von Oktober 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	true

Bilder, die sich in einer Tabelle bzw. Liste befinden, werden auch als separate Bildwebparts unterhalb dieser Tabelle/Liste erstellt. Legen Sie die AddTableListImageAsImageWebPart Eigenschaft auf false fest, wenn Sie die Erstellung dieser separaten Bildwebparts beenden möchten.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    AddTableListImageAsImageWebPart = false,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    AddTableListImageAsImageWebPart = false,
};

UserMappingFile-Option (ab Version von November 2019)

Typ	Standardwert, wenn nicht angegeben
Zeichenfolge	leer

Optional können Sie eine Datei mit benutzerdefinierten Benutzerzuordnungen angeben. Weitere Informationen hierzu finden Sie im Artikel Benutzerzuordnung.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    UserMappingFile = @"c:\temp\usermappingfile.csv",
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    UserMappingFile = @"c:\temp\usermappingfile.csv",
};

LDAPConnectionString-Option (ab Version november 2019)

Typ	Standardwert, wenn nicht angegeben
Zeichenfolge	leer

Optional können Sie eine benutzerdefinierte LDAP-Verbindungszeichenfolge für Ihre Active Directory-Umgebung angeben. Weitere Informationen hierzu finden Sie im Artikel Benutzerzuordnung.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    LDAPConnectionString = "LDAP://OU=Test,DC=CONTOSO,DC=COM",
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    LDAPConnectionString = "LDAP://OU=Test,DC=CONTOSO,DC=COM",
};

SkipUserMapping-Option (ab Version von November 2019)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Das Standardverhalten besteht darin, immer eine Benutzerzuordnung durchzuführen, wenn Sie Seiten aus sharePoint lokal transformieren. Verwenden Sie diese Option, um dies zu deaktivieren. Weitere Informationen hierzu finden Sie im Artikel URL-Zuordnung.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    SkipUserMapping = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    SkipUserMapping = true,
};

TermMappingFile-Option (ab Version von März 2020)

Typ	Standardwert, wenn nicht angegeben
Zeichenfolge	leer

Optional können Sie eine Datei mit benutzerdefinierten Ausdruckszuordnungen angeben. Weitere Informationen finden Sie im Artikel Termmapping.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    TermMappingFile = @"c:\temp\termmappingfile.csv",
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    TermMappingFile = @"c:\temp\termmappingfile.csv",
};

SkipTermStoreMapping-Option (ab Version von März 2020)

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	false

Das Standardverhalten besteht darin, eine Standardbegriffszuordnung durchzuführen. Wenn Sie keine Ausdruckszuordnung wünschen, legen Sie diese Eigenschaft fest. Weitere Informationen finden Sie im Artikel Termmapping.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    SkipTermStoreMapping = true,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    SkipTermStoreMapping = true,
};

HandleWikiImagesAndVideos-Option

Typ	Standardwert, wenn nicht angegeben
Boolescher Wert	true

Eine Wiki-Seite kann eingebettete Video- und Textelemente enthalten, was in einem modernen Text-Webpart nicht möglich ist. Standardmäßig wird der Wiki-Text bei jedem eingebetteten Bild bzw. Video aufgeteilt, und es werden ein Video- oder Bild-Webpart zu der modernen Seite und dann der restliche Originaltext hinzugefügt. Wenn Ihnen diese automatische Einstellung nicht gefällt, können Sie diese Option auf „false“ festlegen, was dazu führt, dass alle eingebetteten Bilder und Videos durch einen Textplatzhalter in Kombination mit einzelnen Video- und Bild-Webparts am Ende der Seite ersetzt werden.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    HandleWikiImagesAndVideos = false,
};

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    HandleWikiImagesAndVideos = false,
};

PageHeader-Option

Typ	Standardwert, wenn nicht angegeben
ClientSidePageHeader	Null

Die Standardkopfzeile für die moderne Seite weist den Typ ClientSidePageHeaderType.None auf, was der Wiki-Kopfzeile am ehesten entspricht. Wenn Sie eine moderne Standardkopfzeile (mit dem großen grauen Bereich) bevorzugen, können Sie hierfür die folgende Option verwenden (siehe auch das Beispiel unten). Sie können auch eine benutzerdefinierte Kopfzeile mit allen verknüpften Optionen wie Hintergrundbild, Ausrichtung usw. konfigurieren.

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    PageHeader = new ClientSidePageHeader(cc, ClientSidePageHeaderType.Default, null),
};

Hinweis

Diese Option ist für die Veröffentlichungsseitentransformation nicht verfügbar. Verwenden Sie das Seitenlayoutzuordnungsmodell, um zu bestimmen, wie der Seitenkopf erstellt werden muss.

PageTitleOverride-Option

Typ	Standardwert, wenn nicht angegeben
Func-Zeichenfolge<, Zeichenfolge>	null

Der Titel der modernen Seite wird von der Quellseite abgeleitet, indem der Seitenname verwendet und die Erweiterung gelöscht wird, Sie können jedoch auch einen beliebigen benutzerdefinierten Seitentitel in den Transformationsfluss einfügen. Im dargestellten Beispiel wird dem Standardtitel das Suffix „_1“ hinzugefügt.

// Local functions
string titleOverride(string title)
{
    return $"{title}_1";
}

PageTransformationInformation pti = new PageTransformationInformation(page)
{
    PageTitleOverride = titleOverride,
};

// Local functions
string titleOverride(string title)
{
    return $"{title}_1";
}

PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
{
    PageTitleOverride = titleOverride,
};

LayoutTransformatorOverride-Option

Typ	Standardwert, wenn nicht angegeben
Func<ClientSidePage, ILayoutTransformator>	null

Das Seitentransformationsmodul verfügt über einen standardmäßigen Layouttransformator, der alle einsatzbereiten Wiki- und Webpart-Seitenlayouts verarbeiten kann. Wenn Sie diese Option jedoch überschreiben möchten, können Sie eine eigene Option angeben.

public class MyLayout : ILayoutTransformator
{
  private ClientSidePage page;

  public MyLayout(ClientSidePage page)
  {
    this.page = page;
  }

  public void Transform(PageLayout layout)
  {
    // custom layout transformation...add sections to the target page based upon the recieved page layout
    switch (layout)
    {
        case PageLayout.Wiki_OneColumn:
        case PageLayout.WebPart_FullPageVertical:
        case PageLayout.Wiki_Custom:
        case PageLayout.WebPart_Custom:
            {
                page.AddSection(CanvasSectionTemplate.OneColumn, 1);
                return;
            }
        // add more incoming layouts...
        default:
            {
                page.AddSection(CanvasSectionTemplate.OneColumn, 1);
                return;
            }
    }
  }
}

// Local functions
ILayoutTransformator layoutOverride(ClientSidePage cp)
{
    return new MyLayout();
}


PageTransformationInformation pti = new PageTransformationInformation(page)
{
    LayoutTransformatorOverride = layoutOverride,
};