Search Results for

    Show / Hide Table of Contents

    Class FunctionProcessor

    Class that executes functions and selectors defined in the mapping

    Inheritance
    System.Object
    BaseTransform
    BaseFunctionProcessor
    FunctionProcessor
    Inherited Members
    BaseTransform.RegisteredLogObservers
    BaseTransform.RegisterObserver(ILogObserver)
    BaseTransform.FlushObservers()
    BaseTransform.FlushSpecificObserver<T>()
    BaseTransform.LogError(String, String, Exception, Boolean, Boolean)
    BaseTransform.LogInfo(String, String, LogEntrySignificance)
    BaseTransform.LogWarning(String, String)
    BaseTransform.LogDebug(String, String)
    BaseTransform.Log(LogEntry, LogLevel)
    BaseTransform.SetPageId(String)
    BaseTransform.GetExactVersion(ClientRuntimeContext)
    BaseTransform.GetVersion(ClientRuntimeContext)
    Namespace: PnP.Framework.Modernization.Functions
    Assembly: PnP.Framework.dll
    Syntax
    public class FunctionProcessor : BaseFunctionProcessor

    Constructors

    FunctionProcessor(ClientContext, ClientContext, IPage, PageTransformation, BaseTransformationInformation, IList<ILogObserver>)

    Instantiates the function processor. Also loads the defined add-ons

    Declaration
    public FunctionProcessor(ClientContext sourceClientContext, ClientContext targetClientContext, IPage page, PageTransformation pageTransformation, BaseTransformationInformation baseTransformationInformation, IList<ILogObserver> logObservers = null)
    Parameters
    ClientContext sourceClientContext

    ClientContext targetClientContext

    PnP.Core.Model.SharePoint.IPage page

    Client side page for which we're executing the functions/selectors as part of the mapping

    PageTransformation pageTransformation

    Webpart mapping information

    BaseTransformationInformation baseTransformationInformation

    Page transformation information

    IList<ILogObserver> logObservers

    Methods

    Process(ref WebPart, WebPartEntity)

    Executes the defined functions and selectors in the provided web part

    Declaration
    public string Process(ref WebPart webPartData, WebPartEntity webPart)
    Parameters
    WebPart webPartData

    Web Part mapping data

    WebPartEntity webPart

    Definition of the web part to be transformed

    Returns
    System.String

    The ouput of the mapping selector if there was one executed, null otherwise

    ProcessMappingFunctions(ref WebPart, WebPartEntity, Mapping)

    Executes the defined functions and selectors in the provided web part

    Declaration
    public void ProcessMappingFunctions(ref WebPart webPartData, WebPartEntity webPart, Mapping webPartMapping)
    Parameters
    WebPart webPartData

    Web Part mapping data

    WebPartEntity webPart

    Definition of the web part to be transformed

    Mapping webPartMapping

    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