Try our conversational search powered by Generative AI!

AI OnAI Off

Class ExportImportBase

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Base class for export and import of pages

Inheritance
System.Object
ContentTransferContext
ExportImportBase
DataExporter
DataImporter
DefaultDataExporter
DefaultDataImporter
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Enterprise.Internal
Assembly: EPiServer.Enterprise.dll
Version: 11.20.7
Syntax
public abstract class ExportImportBase : ContentTransferContext, ITransferContext, IContentTransferContext, ITransferHandlerContext

Constructors

ExportImportBase()

Declaration
protected ExportImportBase()

Properties

AutoCloseStream

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. If input stream should be closed automatically after the import/export method has been called.

Declaration
public bool AutoCloseStream { get; set; }
Property Value
Type Description
System.Boolean

Categories

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Categories that should be exported or has been imported.

Declaration
public CategoryCollection Categories { get; }
Property Value
Type Description
CategoryCollection

ContentTypeSaveOptions

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. The content type save options

Declaration
public ContentTypeSaveOptions ContentTypeSaveOptions { get; set; }
Property Value
Type Description
ContentTypeSaveOptions

ContinueOnError

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets or sets a value indicating whether [continue on error].

Declaration
public bool ContinueOnError { get; set; }
Property Value
Type Description
System.Boolean

true if [continue on error]; otherwise, false.

CurrentContext

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Access the current export/import context without access to the original class.

Declaration
public static ITransferContext CurrentContext { get; }
Property Value
Type Description
ITransferContext

DeleteChildrenGuids

Declaration
public IList<Guid> DeleteChildrenGuids { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.Guid>

DeleteContent

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets or sets the page collection for pages to delete.

Declaration
public IList<ContentReference> DeleteContent { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<ContentReference>

The pages to delete.

DeleteContentLanguages

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets or sets the page collection for page languages to delete.

Declaration
public IList<LanguageContentReference> DeleteContentLanguages { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<LanguageContentReference>

The page languages to delete.

DeletedPageGuids

Declaration
public IList<Guid> DeletedPageGuids { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.Guid>

DeletedVisitorGroups

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the deleted visitor groups.

Declaration
public IList<Guid> DeletedVisitorGroups { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.Guid>

The deleted visitor groups.

DynamicDataTransfer

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the dynamic data transfer handler instance.

Declaration
public IDynamicDataTransfer DynamicDataTransfer { get; }
Property Value
Type Description
IDynamicDataTransfer

The dynamic data transfer handler.
Remarks

This instance takes care of transfer of DDS objects.

DynamicPropertyDefinitions

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Definitions of dynamic properties that should be exported or has been imported.

Declaration
public IList<PropertyDefinition> DynamicPropertyDefinitions { get; }
Property Value
Type Description
System.Collections.Generic.IList<PropertyDefinition>

ExportPropertySettings

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets or sets a value indicating export property settings.

Declaration
public bool ExportPropertySettings { get; set; }
Property Value
Type Description
System.Boolean

true if [export property settings]; otherwise, false.

FileTransfer

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the file transfer object, that holds the functionality to transfer files..

Declaration
public override IFileTransfer FileTransfer { get; set; }
Property Value
Type Description
IFileTransfer

The file transfer object.
Overrides

Frames

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Frames that should be exported or has been imported.

Declaration
public FrameCollection Frames { get; }
Property Value
Type Description
FrameCollection

IdMappingName

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the name of the file to store the EPiServer content to.

Declaration
protected static string IdMappingName { get; }
Property Value
Type Description
System.String

The name of the content package.

IgnoreHierarchy

Declaration
public bool IgnoreHierarchy { get; set; }
Property Value
Type Description
System.Boolean

IsAborting

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. If the current operation has been aborted by a call to the Abort method.

Declaration
public bool IsAborting { get; set; }
Property Value
Type Description
System.Boolean

IsDone

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. If the current import/export is done.

Declaration
public bool IsDone { get; set; }
Property Value
Type Description
System.Boolean

IsTest

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. If the current import should be started in test mode.

Declaration
public bool IsTest { get; set; }
Property Value
Type Description
System.Boolean

MoveContent

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets or sets the pages identies to move.

Declaration
public Dictionary<Guid, Guid> MoveContent { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.Guid, System.Guid>

A dictionary of pages identities to move to a new parent identity.

PackageContentName

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the name of the package content.

Declaration
protected static string PackageContentName { get; }
Property Value
Type Description
System.String

The name of the package content.

PackageDefinitionName

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the name of the file to store the definition of content (content type def, category def and etc).

Declaration
protected static string PackageDefinitionName { get; }
Property Value
Type Description
System.String

The name of the content package.

PackageExtension

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the transfer package extension.

Declaration
public static string PackageExtension { get; }
Property Value
Type Description
System.String

The extension of the export/import file.

PackageMediaName

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the name of the package that contains media binary.

Declaration
protected static string PackageMediaName { get; }
Property Value
Type Description
System.String

The name of the package that contain media binary.

PackagePostContentName

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the name of the package post content.

Declaration
protected static string PackagePostContentName { get; }
Property Value
Type Description
System.String

The name of the package post content.

Stream

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. The stream that should be used to write or read the actual package.

Declaration
public Stream Stream { get; set; }
Property Value
Type Description
System.IO.Stream

TabDefinitions

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Tabs that should be exported or has been imported.

Declaration
public TabDefinitionCollection TabDefinitions { get; }
Property Value
Type Description
TabDefinitionCollection

TransferHandlers

Declaration
public IEnumerable<TransferHandlerBase> TransferHandlers { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TransferHandlerBase>

VersionID

Declaration
public virtual int VersionID { get; set; }
Property Value
Type Description
System.Int32

VisitorGroups

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets or sets the visitor groups Id.

Declaration
public List<Guid> VisitorGroups { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Guid>

The visitor groups.

Methods

Abort()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Abort the running export/import.

Declaration
public void Abort()

CloseStreamsAndPackages()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Close streams opened by CreateReadStream/CreateWriteStream.

Declaration
protected virtual void CloseStreamsAndPackages()

CreateWritePackage()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Create a package for exporting.

Declaration
protected ZipPackage CreateWritePackage()
Returns
Type Description
System.IO.Packaging.ZipPackage

OnExportProperty(TransformPropertyEventArgs)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Raises the ExportProperty event.

Declaration
public virtual void OnExportProperty(TransformPropertyEventArgs e)
Parameters
Type Name Description
TransformPropertyEventArgs e

The TransformPropertyEventArgs instance containing the event data to export a property.

OnImportProperty(TransformPropertyEventArgs)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Raises the ImportProperty event.

Declaration
public virtual void OnImportProperty(TransformPropertyEventArgs e)
Parameters
Type Name Description
TransformPropertyEventArgs e

The TransformPropertyEventArgs instance containing the event data to import a property.

OpenReadPackage()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Open a package for importing.

Declaration
protected ZipPackage OpenReadPackage()
Returns
Type Description
System.IO.Packaging.ZipPackage

RegisterTransferHandlers()

Declaration
protected void RegisterTransferHandlers()

Implements

Extension Methods