Search Results for

    Show / Hide Table of Contents

    Class PublishingPageTransformationInformation

    Information used to configure the publishing page transformation process

    Inheritance
    System.Object
    BaseTransformationInformation
    PublishingPageTransformationInformation
    Inherited Members
    BaseTransformationInformation.SourcePage
    BaseTransformationInformation.SourceFile
    BaseTransformationInformation.Overwrite
    BaseTransformationInformation.TargetPageName
    BaseTransformationInformation.TargetPageFolder
    BaseTransformationInformation.TargetPageFolderOverridesDefaultFolder
    BaseTransformationInformation.KeepPageSpecificPermissions
    BaseTransformationInformation.RemoveEmptySectionsAndColumns
    BaseTransformationInformation.HandleWikiImagesAndVideos
    BaseTransformationInformation.AddTableListImageAsImageWebPart
    BaseTransformationInformation.MappingProperties
    BaseTransformationInformation.KeepPageCreationModificationInformation
    BaseTransformationInformation.PublishCreatedPage
    BaseTransformationInformation.PostAsNews
    BaseTransformationInformation.DisablePageComments
    BaseTransformationInformation.SkipUrlRewrite
    BaseTransformationInformation.SkipDefaultUrlRewrite
    BaseTransformationInformation.UrlMappingFile
    BaseTransformationInformation.SkipHiddenWebParts
    BaseTransformationInformation.TermMappingFile
    BaseTransformationInformation.SkipTermStoreMapping
    BaseTransformationInformation.SkipUserMapping
    BaseTransformationInformation.UserMappingFile
    BaseTransformationInformation.LDAPConnectionString
    BaseTransformationInformation.PageTitleOverride
    BaseTransformationInformation.LayoutTransformatorOverride
    BaseTransformationInformation.ContentTransformatorOverride
    BaseTransformationInformation.SkipTelemetry
    Namespace: PnP.Framework.Modernization.Publishing
    Assembly: PnP.Framework.dll
    Syntax
    public class PublishingPageTransformationInformation : BaseTransformationInformation

    Constructors

    PublishingPageTransformationInformation()

    For internal use only

    Declaration
    public PublishingPageTransformationInformation()

    PublishingPageTransformationInformation(ListItem)

    Instantiates the page transformation class

    Declaration
    public PublishingPageTransformationInformation(ListItem sourcePage)
    Parameters
    ListItem sourcePage

    Page we want to transform

    PublishingPageTransformationInformation(ListItem, Boolean)

    Instantiates the page transformation class

    Declaration
    public PublishingPageTransformationInformation(ListItem sourcePage, bool overwrite)
    Parameters
    ListItem sourcePage

    Page we want to transform

    System.Boolean overwrite

    Do we overwrite the target page if it already exists

    Properties

    EnableEnterpriseWikiCapabilities

    Enables Enterprise Wiki destination preparation, same-name category/rating mappings and optional sidebar insertion. Defaults to false, preserving legacy transformation behavior for all destinations. Required site columns and term sets must already exist. Rating fields omitted from a partial source item are loaded before migrating rating history.

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

    IncludeEnterpriseWikiSidebar

    Adds the native Enterprise Wiki sidebar when EnableEnterpriseWikiCapabilities is true and the source is an Enterprise Wiki page. The destination must support the modernized control host; this option does not deploy it. Set to false for environments without that renderer.

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

    Methods

    GetFirstNonEmptyFieldName(String[])

    Given a collection of field names will return the first one which contains a value which is not null or empty.

    Declaration
    public string GetFirstNonEmptyFieldName(string[] fieldNames)
    Parameters
    System.String[] fieldNames

    A array of Internal field names to check

    Returns
    System.String

    An Internal field name

    IsFieldUsed(String)

    Checks if a field is in use

    Declaration
    public virtual bool IsFieldUsed(string fieldName)
    Parameters
    System.String fieldName

    Internal field name

    Returns
    System.Boolean

    True or False

    Extension Methods

    ValidationExtensions.ValidateNotNullOrEmpty<T>(T, String)
    ObjectExtensions.Set<TObject, T>(TObject, Expression<Func<TObject, T>>, T, Boolean, Boolean)
    ObjectExtensions.GetPublicInstancePropertyValue(Object, String)
    ObjectExtensions.GetPublicInstanceProperty(Object, String)
    ObjectExtensions.SetPublicInstancePropertyValue(Object, String, Object)
    Extensions.ToByteArray(Object)
    Back to top PnP Framework
    Generated by DocFX with Material UI
    spacer