C# Class OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ObjectField

Inheritance: ObjectHandlerBase
Show file Open project: OfficeDev/PnP-Sites-Core Class Usage Examples

Public Methods

Method Description
ExtractObjects ( Web web, OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate template, OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ProvisioningTemplateCreationInformation creationInfo ) : OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate
ProvisionObjects ( Web web, OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate template, TokenParser parser, OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ProvisioningTemplateApplyingInformation applyingInformation ) : TokenParser
WillExtract ( Web web, OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate template, OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ProvisioningTemplateCreationInformation creationInfo ) : bool
WillProvision ( Web web, OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate template ) : bool

Private Methods

Method Description
CleanupEntities ( OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate template, OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate baseTemplate ) : OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate
CreateField ( Web web, System.Xml.Linq.XElement templateFieldElement, PnPMonitoredScope scope, TokenParser parser, string originalFieldXml ) : void
GetTaxonomyFieldValidatedValue ( TaxonomyField field, string defaultValue ) : string
ParseFieldSchema ( string schemaXml, ListCollection lists ) : string
TokenizeFieldFormula ( Microsoft fields, FieldCalculated field, string fieldXml ) : string

Tokenizes calculated fieldXml to use tokens for field references

TryParseTaxonomyFieldValue ( string value, TaxonomyFieldValue &taxValue ) : bool
UpdateField ( Web web, string fieldId, System.Xml.Linq.XElement templateFieldElement, PnPMonitoredScope scope, TokenParser parser, string originalFieldXml ) : void
ValidateTaxonomyFieldDefaultValue ( TaxonomyField field ) : void

Method Details

ExtractObjects() public method

public ExtractObjects ( Web web, OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate template, OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ProvisioningTemplateCreationInformation creationInfo ) : OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate
web Web
template OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate
creationInfo OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ProvisioningTemplateCreationInformation
return OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate

ProvisionObjects() public method

public ProvisionObjects ( Web web, OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate template, TokenParser parser, OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ProvisioningTemplateApplyingInformation applyingInformation ) : TokenParser
web Web
template OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate
parser TokenParser
applyingInformation OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ProvisioningTemplateApplyingInformation
return TokenParser

WillExtract() public method

public WillExtract ( Web web, OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate template, OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ProvisioningTemplateCreationInformation creationInfo ) : bool
web Web
template OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate
creationInfo OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ProvisioningTemplateCreationInformation
return bool

WillProvision() public method

public WillProvision ( Web web, OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate template ) : bool
web Web
template OfficeDevPnP.Core.Framework.Provisioning.Model.ProvisioningTemplate
return bool