C# Class Transformation.PowerShell.WebPart.WebPartTransformationHelper

Inheritance: OfficeDevPnP.Core.Framework.TimerJobs.TimerJob
ファイルを表示 Open project: OfficeDev/PnP-Transformation Class Usage Examples

Public Properties

Property Type Description
headerWebPart bool

Public Methods

Method Description
AddWebPart ( string webUrl, string configuredWebPartFileName, string configuredWebPartXmlFilePath, string webPartZoneIndex, string webPartZoneID, string serverRelativePageUrl, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "web", string sourceWebPartId = "" ) : bool
AddWebPart_UsingCSV ( string sourceWebPartType, string targetWebPartFileName, string targetWebPartXmlDir, string usageFileName, string outPutFolder, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
ConfigureNewWebPartXml ( string targetWebPartXmlFilePath, string sourceXmlFilesDirectory, string OutPutDirectory, string ActionType = "" ) : void
ConfigureNewWebPartXmlFile ( string targetWebPartXmlFilePath, string sourceXmlFile, string OutPutDirectory ) : void
DeleteUsageFiles_WebPartHelper ( string outPutFolder, string fileName ) : void
DeleteWebPart ( string webUrl, string pageUrl, string _storageKey, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "web" ) : bool
DeleteWebPart_UsingCSV ( string sourceWebPartType, string usageFileName, string outPutFolder, string csvFile, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
GetWebPartProperties ( string pageUrl, string StorageKey, string webUrl, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "web" ) : string
GetWebPartProperties_UsingCSV ( string sourceWebPartType, string usageFilePath, string outPutFolder, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "" ) : void
GetWebPartUsage ( string webPartType, ClientContext clientContext, string outPutDirectory ) : void
GetWebPartUsage_DefaultPages ( string webPartType, ClientContext clientContext, string outPutDirectory ) : void
GetWebPartUsage_TimerJobRun ( object sender, OfficeDevPnP.Core.Framework.TimerJobs.TimerJobRunEventArgs e ) : void
GetWebPartsByWeb ( string WebUrl, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
ReplaceWebPart ( string webUrl, string targetWebPartFileName, string targetWebPartXmlFile, string sourceWebPartStorageKey, string webPartZoneIndex, string webPartZoneID, string serverRelativePageUrl, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "", string sourceWebPartId = "" ) : bool
ReplaceWebPart_UsingCSV ( string sourceWebPartType, string targetWebPartXmlFilePath, string targetWebPartFileName, string targetWebPartXmlDir, string usageFileName, string outPutFolder, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "" ) : void
SetExceptionCSVWebAppSiteColWebUrls ( string webUrl, string sharePointOnline_OR_OnPremise, string userName, string password, string domain ) : void
TransformWebPart_UsingCSV ( string usageFileName, string sourceWebPartType, string targetWebPartFileName, string targetWebPartXmlFilePath, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
UploadAppInAppCatalog ( string appCatalogUrl, string fileName, string appFilePath, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
UploadDependencyFile ( string webUrl, string folderServerRelativeUrl, string fileName, string localFilePath, bool overwriteIfExists, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
WebPartTransformationHelper ( ) : System
WebPartTransformationHelper ( string name ) : System
WebPart_Initialization ( string DiscoveryUsage_OutPutFolder ) : void

Private Methods

Method Description
AddWebPart ( Web web, string serverRelativePageUrl, OfficeDevPnP.Core.Entities.WebPartEntity webPartEntity, string sourceWebPartId = "" ) : bool
CheckForWikiFieldOrPublishingPageContentAndUpdate ( WebPartDefinition webPart, Web web, Microsoft webPartPage, string sourceWebPartId = "" ) : void
CheckWebPartOrAppPartPresenceInSite ( ClientContext clientContext, string targetWebPartXmlFileName, string targetWebPartXmlFilePath ) : bool
DeleteWebPart ( Web web, string serverRelativePageUrl, System.Guid storageKey ) : bool
DeployApp ( ClientContext context, string appFullPath ) : AppInstance
GetPageList ( ClientContext &clientContext ) : List
GetPageRelativeURL ( string WebUrl, string PageUrl, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : string
GetTargetWebPartXmlFilePath ( string webPartId, string targetDirectory ) : string
GetWebPartID ( string webPartID ) : string
GetWebPartPropertiesServiceCall ( ClientContext clientContext, string storageKey, string pageUrl ) : string
GetWebPartShortTypeName ( string webPartType ) : string
IsFeatureOnWeb ( System.Guid FeatureID, ClientContext clientContext ) : bool
IsLibraryExist ( string pageLibraryName, ListCollection collList ) : bool
IsPublishingWeb ( ClientContext clientContext, Web web ) : bool
ReadWebPartUsageCSV ( string sourceWebPartType, string usageFilePath, string outPutFolder, IEnumerable &objWPDInput, string SharePointOnline_OR_OnPremise = "OP", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
UploadDisplayTemplateFile ( string webUrl, string fileName, string localFilePath, bool overwriteIfExists, string displayTemplateCategory, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
UploadWebPartFile ( string webUrl, string fileName, string localFilePath, bool overwriteIfExists, string group, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void

Method Details

AddWebPart() public method

public AddWebPart ( string webUrl, string configuredWebPartFileName, string configuredWebPartXmlFilePath, string webPartZoneIndex, string webPartZoneID, string serverRelativePageUrl, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "web", string sourceWebPartId = "" ) : bool
webUrl string
configuredWebPartFileName string
configuredWebPartXmlFilePath string
webPartZoneIndex string
webPartZoneID string
serverRelativePageUrl string
outPutDirectory string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
ActionType string
sourceWebPartId string
return bool

AddWebPart_UsingCSV() public method

public AddWebPart_UsingCSV ( string sourceWebPartType, string targetWebPartFileName, string targetWebPartXmlDir, string usageFileName, string outPutFolder, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
sourceWebPartType string
targetWebPartFileName string
targetWebPartXmlDir string
usageFileName string
outPutFolder string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
return void

ConfigureNewWebPartXml() public method

public ConfigureNewWebPartXml ( string targetWebPartXmlFilePath, string sourceXmlFilesDirectory, string OutPutDirectory, string ActionType = "" ) : void
targetWebPartXmlFilePath string
sourceXmlFilesDirectory string
OutPutDirectory string
ActionType string
return void

ConfigureNewWebPartXmlFile() public method

public ConfigureNewWebPartXmlFile ( string targetWebPartXmlFilePath, string sourceXmlFile, string OutPutDirectory ) : void
targetWebPartXmlFilePath string
sourceXmlFile string
OutPutDirectory string
return void

DeleteUsageFiles_WebPartHelper() public method

public DeleteUsageFiles_WebPartHelper ( string outPutFolder, string fileName ) : void
outPutFolder string
fileName string
return void

DeleteWebPart() public method

public DeleteWebPart ( string webUrl, string pageUrl, string _storageKey, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "web" ) : bool
webUrl string
pageUrl string
_storageKey string
outPutDirectory string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
ActionType string
return bool

DeleteWebPart_UsingCSV() public method

public DeleteWebPart_UsingCSV ( string sourceWebPartType, string usageFileName, string outPutFolder, string csvFile, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
sourceWebPartType string
usageFileName string
outPutFolder string
csvFile string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
return void

GetWebPartProperties() public method

public GetWebPartProperties ( string pageUrl, string StorageKey, string webUrl, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "web" ) : string
pageUrl string
StorageKey string
webUrl string
outPutDirectory string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
ActionType string
return string

GetWebPartProperties_UsingCSV() public method

public GetWebPartProperties_UsingCSV ( string sourceWebPartType, string usageFilePath, string outPutFolder, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "" ) : void
sourceWebPartType string
usageFilePath string
outPutFolder string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
ActionType string
return void

GetWebPartUsage() public method

public GetWebPartUsage ( string webPartType, ClientContext clientContext, string outPutDirectory ) : void
webPartType string
clientContext ClientContext
outPutDirectory string
return void

GetWebPartUsage_DefaultPages() public method

public GetWebPartUsage_DefaultPages ( string webPartType, ClientContext clientContext, string outPutDirectory ) : void
webPartType string
clientContext ClientContext
outPutDirectory string
return void

GetWebPartUsage_TimerJobRun() public method

public GetWebPartUsage_TimerJobRun ( object sender, OfficeDevPnP.Core.Framework.TimerJobs.TimerJobRunEventArgs e ) : void
sender object
e OfficeDevPnP.Core.Framework.TimerJobs.TimerJobRunEventArgs
return void

GetWebPartsByWeb() public method

public GetWebPartsByWeb ( string WebUrl, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
WebUrl string
outPutDirectory string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
return void

ReplaceWebPart() public method

public ReplaceWebPart ( string webUrl, string targetWebPartFileName, string targetWebPartXmlFile, string sourceWebPartStorageKey, string webPartZoneIndex, string webPartZoneID, string serverRelativePageUrl, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "", string sourceWebPartId = "" ) : bool
webUrl string
targetWebPartFileName string
targetWebPartXmlFile string
sourceWebPartStorageKey string
webPartZoneIndex string
webPartZoneID string
serverRelativePageUrl string
outPutDirectory string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
ActionType string
sourceWebPartId string
return bool

ReplaceWebPart_UsingCSV() public method

public ReplaceWebPart_UsingCSV ( string sourceWebPartType, string targetWebPartXmlFilePath, string targetWebPartFileName, string targetWebPartXmlDir, string usageFileName, string outPutFolder, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A", string ActionType = "" ) : void
sourceWebPartType string
targetWebPartXmlFilePath string
targetWebPartFileName string
targetWebPartXmlDir string
usageFileName string
outPutFolder string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
ActionType string
return void

SetExceptionCSVWebAppSiteColWebUrls() public method

public SetExceptionCSVWebAppSiteColWebUrls ( string webUrl, string sharePointOnline_OR_OnPremise, string userName, string password, string domain ) : void
webUrl string
sharePointOnline_OR_OnPremise string
userName string
password string
domain string
return void

TransformWebPart_UsingCSV() public method

public TransformWebPart_UsingCSV ( string usageFileName, string sourceWebPartType, string targetWebPartFileName, string targetWebPartXmlFilePath, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
usageFileName string
sourceWebPartType string
targetWebPartFileName string
targetWebPartXmlFilePath string
outPutDirectory string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
return void

UploadAppInAppCatalog() public method

public UploadAppInAppCatalog ( string appCatalogUrl, string fileName, string appFilePath, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
appCatalogUrl string
fileName string
appFilePath string
outPutDirectory string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
return void

UploadDependencyFile() public method

public UploadDependencyFile ( string webUrl, string folderServerRelativeUrl, string fileName, string localFilePath, bool overwriteIfExists, string outPutDirectory, string SharePointOnline_OR_OnPremise = "N/A", string UserName = "N/A", string Password = "N/A", string Domain = "N/A" ) : void
webUrl string
folderServerRelativeUrl string
fileName string
localFilePath string
overwriteIfExists bool
outPutDirectory string
SharePointOnline_OR_OnPremise string
UserName string
Password string
Domain string
return void

WebPartTransformationHelper() public method

public WebPartTransformationHelper ( ) : System
return System

WebPartTransformationHelper() public method

public WebPartTransformationHelper ( string name ) : System
name string
return System

WebPart_Initialization() public method

public WebPart_Initialization ( string DiscoveryUsage_OutPutFolder ) : void
DiscoveryUsage_OutPutFolder string
return void

Property Details

headerWebPart public_oe property

public bool headerWebPart
return bool