Class ExportImportBase
Base class for export and import of pages
Inherited Members
Namespace: EPiServer.Enterprise
Assembly: EPiServer.Enterprise.dll
Version: 9.12.2Syntax
public abstract class ExportImportBase : ContentTransferContext, ITransferContext, IContentTransferContext, ITransferHandlerContextConstructors
ExportImportBase()
Declaration
protected ExportImportBase()Properties
AutoCloseStream
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
Categories that should be exported or has been imported.
Declaration
public CategoryCollection Categories { get; }Property Value
| Type | Description |
|---|---|
| CategoryCollection |
ContinueOnError
Gets or sets a value indicating whether [continue on error].
Declaration
public bool ContinueOnError { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
CurrentContext
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
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
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
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
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.
DynamicDataTransferHandler
Gets the dynamic data transfer handler instance.
Declaration
[Obsolete("Use DynamicDataTransfer instead")]
public DynamicDataTransferHandler DynamicDataTransferHandler { get; }Property Value
| Type | Description |
|---|---|
| DynamicDataTransferHandler | The dynamic data transfer handler. |
Remarks
This instance takes care of transfer of DDS objects.
DynamicPropertyDefinitions
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
Gets or sets a value indicating export property settings.
Declaration
public bool ExportPropertySettings { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
FileTransfer
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
Frames that should be exported or has been imported.
Declaration
public FrameCollection Frames { get; }Property Value
| Type | Description |
|---|---|
| FrameCollection |
IdMappingName
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
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
If the current import/export is done.
Declaration
public bool IsDone { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsTest
If the current import should be started in test mode.
Declaration
public bool IsTest { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
MoveContent
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
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
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
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
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
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. |
PageTypes
Page types that should be exported or has been imported.
Declaration
[Obsolete("Use ContentTypes instead", true)]
public PageTypeCollection PageTypes { get; }Property Value
| Type | Description |
|---|---|
| PageTypeCollection |
Stream
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
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
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()
Abort the running export/import.
Declaration
public void Abort()CloseStreamsAndPackages()
Close streams opened by CreateReadStream/CreateWriteStream.
Declaration
protected virtual void CloseStreamsAndPackages()CreateWritePackage()
Create a package for exporting.
Declaration
protected ZipPackage CreateWritePackage()Returns
| Type | Description |
|---|---|
| System.IO.Packaging.ZipPackage |
OnExportProperty(TransformPropertyEventArgs)
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)
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()
Open a package for importing.
Declaration
protected ZipPackage OpenReadPackage()Returns
| Type | Description |
|---|---|
| System.IO.Packaging.ZipPackage |
RegisterTransferHandlers()
Declaration
protected void RegisterTransferHandlers()