Class BaseTransformationInformation

Information used to configure the page transformation process which applies to all types of page transformations

Inheritance
System.Object
BaseTransformationInformation
PublishingPageTransformationInformation
PageTransformationInformation
Namespace: PnP.Framework.Modernization.Transform
Assembly: PnP.Framework.dll
Syntax
public abstract class BaseTransformationInformation : object

Properties

AddTableListImageAsImageWebPart

When an image lives inside a table (or list) then also add it as a separate image web part

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

ContentTransformatorOverride

Custom content transformator to be used for this page

Declaration
public Func<IPage, PageTransformation, IContentTransformator> ContentTransformatorOverride { get; set; }
Property Value
Func<PnP.Core.Model.SharePoint.IPage, PageTransformation, IContentTransformator>

DisablePageComments

Disable page comments on the created page

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

HandleWikiImagesAndVideos

If true images and videos embedded in wiki text will be transformed to actual image/video web parts, else they'll get a placeholder and will be added as separate web parts at the end of the page

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

KeepPageCreationModificationInformation

Set this property in case you want to retain the page's Author/Editor/Created/Modified fields. Note that a page publish will always set Editor/Modified

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

KeepPageSpecificPermissions

Apply the item level page permissions on to the target page, defaults to true

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

LayoutTransformatorOverride

Custom layout transformator to be used for this page

Declaration
public Func<IPage, ILayoutTransformator> LayoutTransformatorOverride { get; set; }
Property Value
Func<PnP.Core.Model.SharePoint.IPage, ILayoutTransformator>

LDAPConnectionString

Searches for users within a specific LDAP Connection String, if not specified domain LDAP will be calculated

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

Examples

LDAP://OU=Test,DC=ALPHADELTA,DC=LOCAL

MappingProperties

Property bag for adding properties that will be exposed to the functions and selectors in the web part mapping file. These properties are used to condition the transformation process.

Declaration
public Dictionary<string, string> MappingProperties { get; set; }
Property Value
Dictionary<System.String, System.String>

Overwrite

Overwrite the target page if it already exists?

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

PageTitleOverride

Custom function callout that can be triggered to provide a tailored page title

Declaration
public Func<string, string> PageTitleOverride { get; set; }
Property Value
Func<System.String, System.String>

PostAsNews

Post the created page as news

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

PublishCreatedPage

Should the created page be immediately published (default = true)

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

RemoveEmptySectionsAndColumns

Removes empty sections and columns to optimize screen real estate

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

SkipDefaultUrlRewrite

Skip default URL rewriting, custom URL rewriting using a URL mapping file is still handled

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

SkipHiddenWebParts

Don't transform hidden web parts

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

SkipTelemetry

Disable telemetry: we use telemetry to make this tool better by sending anonymous data, but you're free to disable this

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

SkipTermStoreMapping

Turn off term store mapping

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

SkipUrlRewrite

Skip URL rewriting

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

SkipUserMapping

Don't perform user mapping

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

SourceFile

File to convert - used for web part pages living outside a library as these pages do not have an associated list item

Declaration
public File SourceFile { get; set; }
Property Value
File

SourcePage

Source wiki/webpart page we want to transform

Declaration
public ListItem SourcePage { get; set; }
Property Value
ListItem

TargetPageFolder

Target page folder

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

TargetPageFolderOverridesDefaultFolder

When a target page folder is set, it overwrites the potentially default folder path (e.g. if the source page lived in a folder then that folder is in the default folder path)

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

TargetPageName

Name for the transformed page

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

TermMappingFile

URL to an Term Store Mapping File

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

UrlMappingFile

Url to an URL mapping file

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

UserMappingFile

User Mapping file

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

Extension Methods