Class PageLayoutAnalyser

Inheritance
System.Object
BaseTransform
PageLayoutAnalyser
Inherited Members
Namespace: PnP.Framework.Modernization.Publishing
Assembly: PnP.Framework.dll
Syntax
public class PageLayoutAnalyser : BaseTransform

Constructors

PageLayoutAnalyser(ClientContext, IList<ILogObserver>)

Analyse Page Layouts class constructor

Declaration
public PageLayoutAnalyser(ClientContext sourceContext, IList<ILogObserver> logObservers = null)
Parameters
ClientContext sourceContext

This should be the context of the source web
IList<ILogObserver> logObservers

List of log observers

Methods

AnalyseAll(Boolean)

Main entry point into the class to analyse the page layouts

Declaration
public void AnalyseAll(bool skipOOBPageLayouts = false)
Parameters
System.Boolean skipOOBPageLayouts

Skip OOB page layouts

AnalysePageLayout(ListItem)

Analyses a single page layout from a provided file

Declaration
public PageLayout AnalysePageLayout(ListItem pageLayoutItem)
Parameters
ListItem pageLayoutItem

Page layout list item
Returns
PageLayout

AnalysePageLayoutFromPublishingPage(ListItem)

Determine the page layout from a publishing page

Declaration
public PageLayout AnalysePageLayoutFromPublishingPage(ListItem publishingPage)
Parameters
ListItem publishingPage

Publishing page to analyze the page layout for
Returns
PageLayout

GenerateMappingFile()

Generate the mapping file to output from the analysis

Declaration
public string GenerateMappingFile()
Returns
System.String

Mapping file fully qualified path

GenerateMappingFile(String)

Generate the mapping file to output from the analysis

Declaration
public string GenerateMappingFile(string folder)
Parameters
System.String folder

Folder to generate the file in
Returns
System.String

Mapping file fully qualified path

GenerateMappingFile(String, String)

Generate the mapping file to output from the analysis

Declaration
public string GenerateMappingFile(string folder, string fileName)
Parameters
System.String folder

Folder to generate the file in
System.String fileName

name of the mapping file
Returns
System.String

Mapping file fully qualified path

Extension Methods