Interface IPageTransferContext
Context for transfer of pages
Namespace: EPiServer.Core.Transfer
Assembly: EPiServer.dll
Version: 8.11.0Syntax
[Obsolete("Use IContentTransferContext")]
public interface IPageTransferContextProperties
ClassFactory
Gets the class factory for the transfer functionality.
Declaration
DecoratedClassFactory ClassFactory { get; }Property Value
| Type | Description |
|---|---|
| EPiServer.Implementation.DecoratedClassFactory | The class factory. |
ContentTypesMap
Gets the look up table between incoming content type names and existing content type GUIDs.
Declaration
IDictionary<string, Guid> ContentTypesMap { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Guid> | The map for content type name from package and existing content type GUID. |
CopiedPageLink
Gets or sets the the page link used as root of the copied pages.
Declaration
PageReference CopiedPageLink { get; set; }Property Value
| Type | Description |
|---|---|
| PageReference |
DestinationRoot
Gets or sets the destination root for the transfer.
Declaration
PageReference DestinationRoot { get; set; }Property Value
| Type | Description |
|---|---|
| PageReference | The destination root. |
FileTransfer
Gets the file transfer functionality.
Declaration
IFileTransfer FileTransfer { get; }Property Value
| Type | Description |
|---|---|
| IFileTransfer | The object used to transfer files. |
ForceNewIdentitiesOnExport
Gets or sets a value indicating whether to force new page identifiers for the mirrored pages.
Declaration
bool ForceNewIdentitiesOnExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
IgnorePageHierarchy
Gets a value indicating if the page hierarchy shoud be ignored for the destination pages (all pages will be stored below the destination root).
Declaration
bool IgnorePageHierarchy { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
ImplicitContents
Declaration
Queue<ExportSource> ImplicitContents { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.Queue<ExportSource> |
IsAborting
Gets a value indicating whether the transfer is aborting.
Declaration
bool IsAborting { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
IsCopyByReference
Set to true if a copy, import or export operation should retain the Guid of the pages. Set to false to always create a new page at the destination.
Declaration
bool IsCopyByReference { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsDone
Gets a value indicating whether the transfer is done.
Declaration
bool IsDone { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
LinkGuidMap
Gets the lookup table between page old and new Guids.
Declaration
IDictionary<Guid, Guid> LinkGuidMap { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.Guid, System.Guid> | The map old GUID new link. |
Log
Gets the logger for the context.
Declaration
TransferLogger Log { get; }Property Value
| Type | Description |
|---|---|
| TransferLogger | The logger. |
PageLanguages
Gets the page languages to transfer, if no list of languages is in the list all languages is transfered.
Declaration
IList<string> PageLanguages { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> | The page languages to be transfered. |
SaveAction
Gets the save action for the copied pages.
Declaration
SaveAction SaveAction { get; }Property Value
| Type | Description |
|---|---|
| SaveAction | The save action for the copy pages |
SourceRoots
Gets the roots to tranfer pages from.
Declaration
IList<ExportSource> SourceRoots { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ExportSource> | A list of source roots. |
Methods
Abort()
Aborts the transfer.
Declaration
void Abort()OnExportProperty(TransformPropertyEventArgs)
Raises the event to export a property.
Declaration
void OnExportProperty(TransformPropertyEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| TransformPropertyEventArgs | e | The TransformPropertyEventArgs instance containing the event data. |
OnImportProperty(TransformPropertyEventArgs)
Raises the event to import a property.
Declaration
void OnImportProperty(TransformPropertyEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| TransformPropertyEventArgs | e | The TransformPropertyEventArgs instance containing the event data. |
