Class PageTransformator

Transforms a classic wiki/webpart page into a modern client side page

Inheritance
System.Object
BaseTransform
BasePageTransformator
PageTransformator
Inherited Members
Namespace: PnP.Framework.Modernization.Transform
Assembly: PnP.Framework.dll
Syntax
public class PageTransformator : BasePageTransformator

Constructors

PageTransformator(ClientContext)

Creates a page transformator instance

Declaration
public PageTransformator(ClientContext sourceClientContext)
Parameters
ClientContext sourceClientContext

ClientContext of the site holding the page

PageTransformator(ClientContext, ClientContext)

Creates a page transformator instance with a target destination of a target web e.g. Modern/Communication Site

Declaration
public PageTransformator(ClientContext sourceClientContext, ClientContext targetClientContext)
Parameters
ClientContext sourceClientContext

ClientContext of the site holding the page
ClientContext targetClientContext

ClientContext of the site that will receive the modernized page

PageTransformator(ClientContext, ClientContext, PageTransformation)

Creates a page transformator instance

Declaration
public PageTransformator(ClientContext sourceClientContext, ClientContext targetClientContext, PageTransformation pageTransformationModel)
Parameters
ClientContext sourceClientContext

ClientContext of the site holding the page
ClientContext targetClientContext

ClientContext of the site that will receive the modernized page
PageTransformation pageTransformationModel

Page transformation model

PageTransformator(ClientContext, ClientContext, String)

Creates a page transformator instance

Declaration
public PageTransformator(ClientContext sourceClientContext, ClientContext targetClientContext, string pageTransformationFile)
Parameters
ClientContext sourceClientContext

ClientContext of the site holding the page
ClientContext targetClientContext

ClientContext of the site that will receive the modernized page
System.String pageTransformationFile

Used page mapping file

PageTransformator(ClientContext, PageTransformation)

Creates a page transformator instance

Declaration
public PageTransformator(ClientContext sourceClientContext, PageTransformation pageTransformationModel)
Parameters
ClientContext sourceClientContext

ClientContext of the site holding the page
PageTransformation pageTransformationModel

Page transformation model

PageTransformator(ClientContext, String)

Creates a page transformator instance

Declaration
public PageTransformator(ClientContext sourceClientContext, string pageTransformationFile)
Parameters
ClientContext sourceClientContext

ClientContext of the site holding the page
System.String pageTransformationFile

Used page mapping file

Methods

LoadPageTransformationModel(String)

Loads a page transformation model from file

Declaration
public static PageTransformation LoadPageTransformationModel(string pageTransformationFile)
Parameters
System.String pageTransformationFile

File holding the page transformation model
Returns
PageTransformation

Page transformation model

SwapPages(PageTransformationInformation)

Declaration
public string SwapPages(PageTransformationInformation pageTransformationInformation)
Parameters
PageTransformationInformation pageTransformationInformation

Returns
System.String

Transform(PageTransformationInformation)

Transform the page

Declaration
public string Transform(PageTransformationInformation pageTransformationInformation)
Parameters
PageTransformationInformation pageTransformationInformation

Information about the page to transform
Returns
System.String

The path to the created modern page

Extension Methods