Class PageTransformationInformation

Information used to configure the wiki and web part page transformation process

Inheritance
System.Object
BaseTransformationInformation
PageTransformationInformation
Inherited Members
Namespace: PnP.Framework.Modernization.Transform
Assembly: PnP.Framework.dll
Syntax
public class PageTransformationInformation : BaseTransformationInformation

Constructors

PageTransformationInformation(ListItem)

Instantiates the page transformation class

Declaration
public PageTransformationInformation(ListItem sourcePage)
Parameters
ListItem sourcePage

Page we want to transform

PageTransformationInformation(ListItem, String)

Instantiates the page transformation class

Declaration
public PageTransformationInformation(ListItem sourcePage, string targetPageName)
Parameters
ListItem sourcePage

Page we want to transform
System.String targetPageName

Name of the target page

PageTransformationInformation(ListItem, String, Boolean)

Instantiates the page transformation class

Declaration
public PageTransformationInformation(ListItem sourcePage, string targetPageName, bool overwrite)
Parameters
ListItem sourcePage

Page we want to transform
System.String targetPageName

Name of the target page
System.Boolean overwrite

Do we overwrite the target page if it already exists

Properties

CopyPageMetadata

Copy the page metadata (if any) to the created modern client side page. Defaults to false

Declaration
public bool CopyPageMetadata { get; set; }
Property Value
System.Boolean

ModernizationCenterInformation

Configuration driven by the presence of a modernization center

Declaration
public ModernizationCenterInformation ModernizationCenterInformation { get; set; }
Property Value
ModernizationCenterInformation

PageHeader

Configuration of the page header to apply

Declaration
public IPageHeader PageHeader { get; set; }
Property Value
PnP.Core.Model.SharePoint.IPageHeader

ReplaceHomePageWithDefaultHomePage

If the page to be transformed is the web's home page then replace with stock modern home page instead of transforming it

Declaration
public bool ReplaceHomePageWithDefaultHomePage { get; set; }
Property Value
System.Boolean

SetAuthorInPageHeader

Sets the page author in the page header similar to the original page author

Declaration
public bool SetAuthorInPageHeader { get; set; }
Property Value
System.Boolean

SourcePagePrefix

Prefix used to name the source page. Used in conjunction with TargetPageTakesSourcePageName

Declaration
public string SourcePagePrefix { get; set; }
Property Value
System.String

TargetPagePrefix

Prefix used to name the target page

Declaration
public string TargetPagePrefix { get; set; }
Property Value
System.String

TargetPageTakesSourcePageName

Target page will get the source page name, source page will be renamed. Used in conjunction with SourcePagePrefix

Declaration
public bool TargetPageTakesSourcePageName { get; set; }
Property Value
System.Boolean

Methods

SetDefaultSourcePagePrefix()

Set's default source page prefix

Declaration
public void SetDefaultSourcePagePrefix()

SetDefaultTargetPagePrefix()

Set's default target page prefix

Declaration
public void SetDefaultTargetPagePrefix()

Extension Methods